Generates a Python project structure with github actions for continuous integration and continuous deployment. Both pure Python projects and Python projects with Rust modules using PyO3 can be created.
For package managment choose between:
Dev packages:
- mypy for static type checking
- pytest for testing
- pytest-cov for test coverage reports
- ruff for linting and code formatting
- maturin for package management
- mypy for static type checking
- pytest for testing
- pytest-cov for test coverage reports
- ruff for linting and code formatting
- PyO3 for managing the Rust/Python FFI
- justfile for running commands (to use this you will need to install just)
Install with cargo
:
cargo install python-project-generator
Install on Arch with the AUR:
paru -S python-project-generator-bin
Install on Debian/Ubuntu:
Note: Change the version to match the version you want to install.
curl -LO https://github.com/sanders41/python-project-generator/releases/download/v1.0.16/python-project-generator_1.0.16_amd64.deb
sudo dpkg -i python-project-generator_1.0.16_amd64.deb
Python Project Generator can also be installed with binaries provided with each release here, or with cargo.
From your terminal run:
python-project create
You will be asked a series of questions that will be used to generate your project. The project
generator will check pypi for the lastest version of the included packages and use those while
generating the project. This feature can be disabled by using with either -s
or
--skip-download-latest-packages
when running the generator. If either there is an issue with
retrieving the latest versions or if you have decided to skip looking up the latest version, the
packages will be be created with default versions.
python-project create -s
After running the generator a new directory will be created with the name you used for the
Project Slug
. Change to this directory then install the python packages and pre-commit hooks.
Install the Python dependencies when using Poetry.
poetry install
Install the Python dependencies when using setuptools.
First create a virtual environment and activate it.
python -m venv .venv
. .venv/bin/activate
python -m pip install -r requirements-dev.txt
Install the pre-commit hooks.
pre-commit install
First create a virtual environment and activate it.
python -m venv .venv
. .venv/bin/activate
Install the dependencies and build the rust module.
just install
Install the pre-commit hooks.
pre-commit install
Now your project is ready to use.
You can specify default values for many of the project options. For example to save a default creator:
python-project config creator "Wade Watts"
To see a full list of values that be set as defaults run:
python-project config --help
To view the current saved defaults:
python-project config show
To remove custom defaults:
python-project config reset
If you are interested in contributing please see our contributing guide