aimingmed-ai/app/proto-docs/docs/index.md

Introduction

This documentation contains Python recommended practice. It is intended to be used as a reference for Python developers.

TODO Project:

1. Deploy this documentation to Azure Static Web Apps. Set it private for Evonik users and ensure the url page is fixed so it is easy to be share and bookmarked.

2. Create Python template with cookiecutter and possibly cruft

   References:

   • Introducing a project template for modern Python packages

TODO Documentation Contents:

1. Dockerize the project

   References:

   • https://pythonspeed.com/docker/

2. Setup environment variables thorugh .env

3. CI / CD with Azure Pipelines

4. Testing with pytest, coverage, mock, and tox

   References:

   • https://cjolowicz.github.io/posts/hypermodern-python-02-testing/

5. Makefile / pre-commit

   References:

   • https://earthly.dev/blog/python-makefile/
   • https://pre-commit.com/

6. Logging with structlog instead?

   References:

   • https://www.structlog.org/en/stable/