@@ -11,14 +11,10 @@ and pull requests were marked as "spam" ([#1332], [#1421], [#1431],
1111* Flake8-pyproject* also has bad manners and force-feeds Flake8 the
1212spam it so despises.
1313
14- It is inspired by [ pyproject-Flake8] , which had received little
15- maintenance following its initial commit. Though this may have changed
16- in the meantime. Consider using it instead, or any of the other
17- alternatives mentioned in [ issue #2 ] .
18-
19- Compared to ` pyproject-Flake8 ` , the code here (little as there was to
20- begin with) was completely rewritten and a simple test suite makes it
21- all a little more palatable.
14+ It is inspired by [ pyproject-Flake8] , though the code was rewritten
15+ from scratch and a test suite was added to make maintenance easier.
16+ You may however consider using the original project instead, or any
17+ of the other alternatives mentioned in [ issue #2 ] .
2218
2319[ Flake8 ] : https://github.com/PyCQA/flake8
2420[ #234 ] : https://github.com/PyCQA/flake8/issues/234
@@ -36,9 +32,6 @@ all a little more palatable.
3632First, move your Flake8 configuration to ` pyproject.toml ` . Then,
3733optionally, add Flake8p as a git pre-commit hook.
3834
39-
40- ### Move the configuration
41-
4235Say your Flake8 configuration in ` .flake8 ` (or in ` tox.ini ` , or
4336` setup.cfg ` ) is this:
4437``` ini
@@ -65,13 +58,8 @@ count = true
6558From then on run ` flake8p ` instead of ` flake8 ` to lint the code, so that
6659the configuration in ` pyproject.toml ` will be used.
6760
68- [ TOML format ] : https://toml.io
69-
70-
71- ### Add pre-commit hook
72-
73- Automatically apply ` flake8p ` upon ` git commit ` by adding the following
74- to your project's pre-commit configuration:
61+ To have ` flake8p ` run on every ` git commit ` , add the following to your
62+ project's pre-commit configuration:
7563
7664``` yaml
7765# your-project-root/.pre-commit-hooks.yaml
@@ -81,6 +69,8 @@ to your project's pre-commit configuration:
8169 - id : Flake8-pyproject
8270` ` `
8371
72+ [TOML format]: https://toml.io
73+
8474
8575## Implementation
8676
0 commit comments