SDS - Python - Standards
Here you will find all the standards and best practices to be followed when developing software with the Python programming language for the FAA-VAIL project.
1. Repository Layout - Top-Level Directories
Source: Python Application Layouts: A Reference
2. Style
Source: PEP 8 – Style Guide for Python Code
3. Quality Ensurance Tools
a) Formatter
- black - uncompromising Python code formatter
- docformatter - formats docstrings to follow PEP 257
- isort - a Python utility / library to sort imports
b) Static Code Analyser
- Bandit - a tool designed to find common security issues in Python code
- Flake8 - a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code, includes:
- Pylint - it's not just a linter that annoys you
- mypy - optional static typing for Python
- pydocstyle - docstring style checker
c) Testing Frameworks
- pytest - the pytest framework makes it easy to write small tests, yet scales to support complex functional testing
- pytest-cov - coverage plugin for pytest
- pytest-deadfixtures - plugin to list unused fixtures in your tests
- pytest-helpers-namespace - enables you to register helper functions in your conftest.py
- pytest-random-order - pytest plugin to randomise the order of tests with some control over the randomness
d) Documentation
- Material for MkDocs - a material design theme for MkDocs
- MkDocs - project documentation with Markdown
- mkdocs-autoref - Automatically link across pages in MkDoc
- mkdocs-awesome-pages-plugin - MkDocs Awesome Pages Plugin
- mkdocs-material-extensions - MkDocs Material Extensions
- mkdocstrings - automatic documentation from sources for MkDocs
- mkdocstrings-python - a Python handler for mkdocstrings