PYTHON.md

Python best practises used

Developing

• Flask adapts python for web-development.
• Git is used for version control.
• The source is available everywhere from a remote repo on GitHub.
• LICENSE is present and clearly articulates the legal side.
• .gitignore prevents pushing wrong files.
• requirements.txt mentions necessary modules.
• Virtual Environment protects from library clashes.
• Documentation helps others to understand the code.
• Modules and functions organize code into concise reusable parts.
• autopep8 facilitates code quality through linting.
• worldtimeapi.org endpoint ensures data integrity.

Testing

• Test via standard pytest package.
• Use naming conventions with test_* files in tests folder.
• Test small pieces of code.
• Adopt test-driven development practices.
• Differentiate different types of tests (e.g. unit, integration, etc.)
• Comment testing functions.