Default python template for any project.
- Linters and formatters(black, mypy, isort, ruff).
- Pytest and coverage libraries for testing.
- Sphinx or mkdocs(WIP) - add for documendation.
- Add pre-commit
- Environment variables for local start up in .env.example file. Create .env file from example.
- Environment variables for docker compose in docker-compose.yml file
- ENVIRONMENT - define environment for application
-
Using local shell
- Dependencies installation
- Create shell using poetry
poetry shell
- Install
poetry install
- Create shell using poetry
- Running application
docker/start.sh
- Dependencies installation
-
Using docker
- Using docker-compose
docker-compose up app
- Using Makefile
make dc-up
- Rebuilding application without cache
make dc-build
- Using docker-compose
- Using docker-compose
make dc-test
-
Run only check
make lint-check
-
Run linters and modify files
make lint
- Export enviroment variables from .env file
source docker/export.sh
- Wait for some service
NAME=Redis HOST=${REDIS_HOST} PORT=${REDIS_PORT} ./docker/wait-for-service.sh