python-template

A python template that provided default pre-commit and pip-compile-multi features.

How to install template for development?

1. Install cookiecutter at your environment:

$ pip install cookiecutter

2. Load structure:

$ cookiecutter gh:quequsha/python-template

3. Install development dependicies:

$ pip install -Ur requirements/dev.txt

4. Init git if needed:

$ git init

5. Add remote repo if needed:

$ git remote add origin <repo>

6. Init pre-commit:

$ pre-commit

7. Install pre-commit hooks:

$ pre-commit install

How to use template?

Each core dependency add to requirements/base.in

Before commit run pip-compile-multi

After git commit ... will call pre-commit check automatically.

At production you should only install dependicies: pip install -Ur requirements/base.txt

Additional hooks

Your can add another pre-commit hooks to .pre-commit-config.yaml Explore:

• supported hooks
• pre-commit-hooks
• awesome-flake8-extensions

Development packages

• pytest
• pysnooper
• py-spy
• memray

Useful commands

Run commit without pre-commit:

$ git commit --no-verify

Run pre-commit against all the files:

$ pre-commit run --all-files

Configure dependicies:

$ pip-compile-multi