mirror of
https://github.com/aimingmed/aimingmed-ai.git
synced 2026-02-01 12:23:01 +08:00
42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
# 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`](https://cookiecutter.readthedocs.io/en/latest/) and possibly [`cruft`](https://cruft.github.io/cruft/)
|
|
|
|
References:
|
|
|
|
- [Introducing a project template for modern Python packages](https://blog.wolt.com/engineering/2022/08/11/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/
|