Code Quality

CI/CD

We use Github workflows for our pipeline.

Our pipeline can be found here and the runs of the pipeline are visible under Actions.

We use the following tools:

• poetry for managing dependencies and publishing the package
• pytest for tests
• pytest-cov for test coverage
• black for autoformatting
• isort for sorting and grouping Python import statements
• flake9 (wrapper for flake8 that supports pyproject.toml as config) for linting and complexity checks
• pylint for linting, using the .pylintrc from Google
• bandit for security
• safety for security
• mypy for static type checking
• pdoc3 for generating documentation

Resources

• Python Code Quality
• Automate Python workflow using pre-commits: black and flake8
• 5 Awesome Tools for Python Code Quality
• McCabe’s Cyclomatic Complexity with Flow Graph (Example)
• PEP 8 – Style Guide for Python Code
• Google Python Style Guide
• Type hints cheat sheet (Python 3)¶