Update docs to latest practices (#40)

gahjelle · web-flow · commit 17850011d3b3 · 2022-10-06T09:21:54.000+02:00
* Update changelog with project changes
* Update contributing guidelines to include flake8 and isort
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -1,6 +1,6 @@
 # Authors and Contributors
 
-`codetiming` is written and maintained by the [_Real Python_ team](https://realpython.com/team/).
+`codetiming` is written and maintained by the [Real Python team](https://realpython.com/team/).
 
 
 ## Author and Maintainer
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - A `py.typed` file to mark `codetiming` as typed as specified in [PEP 561](https://peps.python.org/pep-0561/#packaging-type-information) (by [@alkatar21](https://github.com/alkatar21) in [#38])
 
+### Changed
+
+- Use GitHub Actions instead of CircleCI for CI ([#33])
+- Explicitly support Python 3.10 and 3.11 ([#32], [#34], [#35])
 
 ## [1.3.0] - 2021-02-09
 
@@ -61,4 +65,8 @@ Initial version of `codetiming`. Version 1.0.0 corresponds to the code in the tu
 [#27]: https://github.com/realpython/codetiming/pull/27
 [#29]: https://github.com/realpython/codetiming/issues/29
 [#30]: https://github.com/realpython/codetiming/pull/30
+[#32]: https://github.com/realpython/codetiming/pull/32
+[#33]: https://github.com/realpython/codetiming/pull/33
+[#34]: https://github.com/realpython/codetiming/pull/34
+[#35]: https://github.com/realpython/codetiming/pull/35
 [#38]: https://github.com/realpython/codetiming/pull/38
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -47,27 +47,39 @@ Run tests using [`tox`](https://tox.readthedocs.io/). `tox` helps to enforce the
 
 - Consistent code style using [`black`](https://black.readthedocs.io). You can automatically format your code as follows:
 
-    ```
-    $ black codetiming/
+    ```console
+    $ python -m black codetiming/ tests/
     ```
 
 - Static type hinting using [`mypy`](http://mypy-lang.org/). Test your type hints as follows:
 
-    ```
+    ```console
     $ mypy --strict codetiming/
     ```
 
     See Real Python's [Python Type Checking guide](https://realpython.com/python-type-checking/) for more information.
 
 - Unit testing using [`pytest`](https://docs.pytest.org/). You can run your tests and see a coverage report as follows:
 
-    ```
+    ```console
     $ pytest --cov=codetiming --cov-report=term-missing
     ```
 
-- All modules, functions, classes, and methods must have docstrings. This is enforced by [Interrogation](https://interrogate.readthedocs.io/). You can test compliance as follows:
+- Code issues are checked with the [flake8]() linter. You can run flake8 manually as follows:
+
+    ```console
+    $ python -m flake8 codetiming/ tests/
+    ```
+
+- Imports are sorted consistently using [isort](https://pycqa.github.io/isort/). You can automatically sort your imports as follows:
 
+    ```console
+    $ python -m isort codetiming/ tests/
     ```
+
+- All modules, functions, classes, and methods must have docstrings. This is enforced by [Interrogation](https://interrogate.readthedocs.io/). You can test compliance as follows:
+
+    ```console
     $ interrogate -c pyproject.toml -vv
     ```
 
diff --git a/tests/test_codetiming.py b/tests/test_codetiming.py
@@ -23,19 +23,19 @@
 
 def waste_time(num=1000):
     """Just waste a little bit of time"""
-    sum(n ** 2 for n in range(num))
+    sum(n**2 for n in range(num))
 
 
 @Timer(text=TIME_MESSAGE)
 def decorated_timewaste(num=1000):
     """Just waste a little bit of time"""
-    sum(n ** 2 for n in range(num))
+    sum(n**2 for n in range(num))
 
 
 @Timer(name="accumulator", text=TIME_MESSAGE)
 def accumulated_timewaste(num=1000):
     """Just waste a little bit of time"""
-    sum(n ** 2 for n in range(num))
+    sum(n**2 for n in range(num))
 
 
 class CustomLogger:
diff --git a/tox.ini b/tox.ini
@@ -20,8 +20,8 @@ deps =
     isort
     mypy
 commands = 
-    {envpython} -m black --check --quiet codetiming/
-    {envpython} -m flake8 codetiming/
+    {envpython} -m black --check --quiet codetiming/ tests/
+    {envpython} -m flake8 codetiming/ tests/
     {envpython} -m interrogate --quiet --config=pyproject.toml
-    {envpython} -m isort --check codetiming/
+    {envpython} -m isort --check codetiming/ tests/
     {envpython} -m mypy --strict codetiming/
