Python package structure

[yakutovicha]

Advanced

Here is a list of pre-commit checks that I typically use for my project:

• Linters: flake8, pylint. My choice: [flake8]. Additional flake8-plugins:
  • flake8-bugbear for detecting bugs and potential design problems
  • flake8-builtins for verifying that builtins are not used as variable names
  • flake8-comprehensions for writing better and consistent comprehensions
  • flake8-debugger for checking that there are no forgotten breakpoints
  • flake8-eradicate to avoid “dead” or commented code
  • flake8-logging-format for consistent logging
  • pep8-naming for verifying that PEP8 naming conventions are followed
  • tryceratops to avoid exception anti-patterns
• Type checking: mypy. My choice: [mypy]
  • types-click-spinner
  • types-requests, types-tabulate, types-toml
• Auto-formatters:
  • isort for sorting imports
  • autoflake for removing unused imports
  • black for formatting the rest of the code.
• Python auto-update: pyupgrade tool to automatically upgrade syntax for newer versions of the language.

[yakutovicha]

Flake8 configuration file.

It would be great, of course, to make the config below a part of the pyproject.toml. Unfortunately, this is not possible. Nevertheless, this is the content of .flake8 (needed mostly due to the conflicts with black):

[flake8]
extend-ignore =
    E501
    W503
    E203