{{ cookiecutter.project_name.replace('-', ' ').replace('_', ' ') }}

Installation

git clone {{ cookiecutter.git_repo_url }}.git
cd {{ cookiecutter.project_name.lower().replace(' ', '-') }}

make uv-download

make install
make pre-commit-install

make format lint test

Makefile contains a lot of functions for faster development.

1. Download uv

To download and install uv run:

make uv-install

2. Install all dependencies and pre-commit hooks

Install requirements:

make install

Pre-commit hooks coulb be installed after git init via

make pre-commit-install

3. Codestyle

Automatic formatting uses ruff formatter

make codestyle

# or use synonym
make format

Codestyle checks only, without rewriting files:

make check-codestyle

Update all libraries to the latest version using one command

make update

4. Code security

This command identifies security issues with Safety

make check-safety

5. Type checks

Run mypy static type checker

make mypy

6. Tests with coverage

Run pytest

make test

7. All linters

Of course there is a command to ~~rule~~ run all linters in one:

make lint

8. Docker

Run with docker compose

make docker-up

9. Cleanup

Delete cache and build files:

make cleanup

This project was generated with python-package-template