Python Coding Standards

General style

• Adhere to PEP-8 guidelines.
• Use Ruff for automated formating and linting.
• Include descriptive and informative docstrings at the function and class level, adhering to Numpydoc format.

Type hinting

• Include type hints that adhere to PEP-484 guidelines.
• Additional type checking can be performed by MyPy.
• For dataframes, we should define Pandera schemas. This allows us to define column names once and reuse anywhere. It also gives us additional functionality for type checking, validation and data synthesis.

Dependency management

• Dependencies and their versions are stored in 'requirements.txt'.