Usage¶
Remember that wemake-python-styleguide
is just a flake8
plugin.
Running¶
To run our linter you will need to run flake8
in any way you like:
flake8 your_module.py
flake8 your_package
See the official docs for options and usage examples.
Golden rule is to run your linter on each commit locally and inside the CI. And to fail the build if there are any style violations.
Integrations¶
We leverage all the existing flake8
infrastructure.
There are different integrations for your workflow.
Hooks¶
- pytest-flake8 to run style checks alongside with tests (recommended)
- pre-commit to run
flake8
before all commits locally
Editors¶
Uninstall¶
We do not recommend to uninstall our linter ;)
But, in case you really have to, we can help you with an advice:
- use
poetry
orpipenv
, this way all our dependencies will also be removed alongside the main tool - if you still use
pip
, you will have to manually delete all the dependencies which can be found in project’s pyproject.toml