Easily kickstart your Python project with very opionionated best practices.
- Manage your project using poetry https://python-poetry.org/
- Add testing with pytest and pytest-cov
- Run checks before commiting using pre-commit
- Code analysis and formatting with Flake8, Mypy, Isort and Black
This is based on this excellant article: Python Best Practices for a New Project and some of my own experiance.
⚠️ Warning: Poetry must be installed.
If you have go installed, simply run:
go install github.com/luciferchase/pyproject
Binaries for Windows are available in the Release page.
You have to manually add the pyproject.exe
file to your path.
git clone
this repository and run:
go build -o bin\pyproject.exe main.go
You have to manually add the pyproject.exe
[availabe in the .\bin
dir] to your path.
Well, dependency management and static typing in Python is a hot mess. To avoid this, we use various tools like poetry
, pytest
, flake8
, mypy
, black
and so many more.
Thus to fast track starting a new Python project, I wrote this for myself.