@@ -16,13 +16,13 @@ details on how to [install docker][install-docker] on your computer.
1616Once that is configured, the test suite can be run locally:
1717
1818``` bash
19- docker- compose run --rm test
19+ docker compose run --rm test
2020```
2121
2222If you want to be able to execute code in the container:
2323
2424``` bash
25- docker- compose run --rm devbox
25+ docker compose run --rm devbox
2626(your code here)
2727```
2828
@@ -50,11 +50,11 @@ See the documentation on [pdb][pdb-docs] and [pdb++][pdbpp-docs] for more inform
5050You'll be unable to merge code unless the linting and tests pass. You can run these in your container via:
5151
5252``` bash
53- docker- compose run --rm test
53+ docker compose run --rm test
5454```
5555
5656This will run the same tests, linting, and code coverage that are run by the CI pipeline. The only difference is that,
57- when run locally, ` black ` and ` isort ` are configured to automatically correct issues they detect .
57+ when run locally, ` ruff ` is configured to automatically fix issues it detects (with the ` --format-code ` flag) .
5858
5959Generally we should endeavor to write tests for every feature. Every new feature branch should increase the test
6060coverage rather than decreasing it.
@@ -67,10 +67,8 @@ To customize / override a specific testing stage, please read the documentation
6767
68681 . [ PyTest] [ pytest-docs ]
69692 . [ MyPy] [ mypy-docs ]
70- 3 . [ Black] [ black-docs ]
71- 4 . [ Isort] [ isort-docs ]
72- 5 . [ Flake8] [ flake8-docs ]
73- 6 . [ Bandit] [ bandit-docs ]
70+ 3 . [ Ruff] [ ruff-docs ]
71+ 4 . [ Bandit] [ bandit-docs ]
7472
7573### Building the Library
7674
@@ -119,8 +117,8 @@ This same pipeline also runs on the default branch when a maintainer merges a pu
119117
120118### Lints
121119
122- The first set of jobs that run as part of the CI pipline are linters that perform static analysis on the code. This
123- includes: [ MyPy] [ mypy-docs ] , [ Black ] [ black-docs ] , [ Isort ] [ isort-docs ] , [ Flake8 ] [ flake8 -docs] , and [ Bandit] [ bandit-docs ] .
120+ The first set of jobs that run as part of the CI pipeline are linters that perform static analysis on the code. This
121+ includes: [ MyPy] [ mypy-docs ] , [ Ruff ] [ ruff -docs] , and [ Bandit] [ bandit-docs ] .
124122
125123### Tests
126124
@@ -145,9 +143,7 @@ The pipeline runs the tests cases across each supported version of Python to ens
145143[ pdbpp-docs ] : https://github.com/pdbpp/pdbpp#usage
146144[ pytest-docs ] : https://docs.pytest.org/en/latest/
147145[ mypy-docs ] : https://mypy.readthedocs.io/en/stable/
148- [ black-docs ] : https://black.readthedocs.io/en/stable/
149- [ isort-docs ] : https://pycqa.github.io/isort/
150- [ flake8-docs ] : http://flake8.pycqa.org/en/stable/
146+ [ ruff-docs ] : https://docs.astral.sh/ruff/
151147[ bandit-docs ] : https://bandit.readthedocs.io/en/stable/
152148[ sem-ver ] : https://semver.org/
153149[ pep-517 ] : https://www.python.org/dev/peps/pep-0517
0 commit comments