Project README! Here we go!

• Repository contents
• System requirements
• How to run server

Repository contents

• docs - documentation of the project
• reports - reports generated (as generated from notebooks)

  Check if you need to ignore large reports or keep them in Git LFS

• configs - configuration files directory
• notebooks - directory for jupyter notebooks
• tests - project tasts based on pytest
• scripts - repository service scripts

  These ones are not included into the pakckage if you build one - these scripts are only for usage with repository

• python_ml_project_api - source files of the project
• .editorconfig - configuration for editorconfig
• .gitignore - the files/folders git should ignore
• .pre-commit-config.yaml - pre-commit configuration file
• README.md - the one you read =)
• DEVELOPMENT.md - guide for development team
• Makefile - targets for make command
• cookiecutter-config-file.yml - cookiecutter project config log
• poetry.toml - poetry local config
• pyproject.toml - Python project configuration
• .env.example - Example of .env file, some rules:

  • [!WARNING] Don't store credential in examples, fill real credentials in .env file itself

  • Use longer names to understand relations between envs and services

System requirements

• Python version: 3.9
• Operating system: Ubuntu or WSL
• Poetry version defined in poetry.version

We tested on this setup - you can try other versions or operation systems by yourself!

How to run server

• Create .env file from .env.example
• Run app in docker mode

  make app-docker-start

Swagger URL http://127.0.0.1:8080/api/v1/docs

Flower (Celery dashboard) URL http://127.0.0.1:5555/