5 hacks to improve your code in 5 minutes

Readme.md

5 hacks to improve your code in 5 minutes

1. black

Stop having flamewars about code style.

• website: https://github.com/python/black

2. isort

Stop having flamewars about how to sort imports.

• website: https://pypi.org/project/isort/
• example configuration: https://github.com/Pylons/pyramid_openapi3/blob/master/.isort.cfg

3. codespell

Stop having typos in your code.

• website: https://pypi.org/project/codespell/
• example configuration: https://github.com/Pylons/pyramid_openapi3/blob/master/.aspell.en.pws

4. pydocstyle

Stop having poor or non-existent docstrings.

• website: http://www.pydocstyle.org/en/stable/
• If you already use flake8: https://pypi.org/project/flake8-docstrings/
• example configuration: https://github.com/Pylons/pyramid_openapi3/blob/master/.flake8#L9

5. pre-commit

Make sure all of the above are enforced.

• website: https://pre-commit.com/
• example configuration: https://github.com/Pylons/pyramid_openapi3/blob/master/.pre-commit-config.yaml