Python Project Generator

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.

Pure Python project included packages

• poetry for package managment
• black for code formatting
• mypy for static type checking
• pre-commit for pre-commit hooks
• pytest for testing
• pytest-cov for test coverage reports
• ruff for linting

Python project with Rust modules included packages

• maturin for package management
• black for code formatting
• mypy for static type checking
• pre-commit for pre-commit hooks
• pytest for testing
• pytest-cov for test coverage reports
• ruff for linting
• PyO3 for managing the Rust/Python FFI
• justfile for running commands (to use this you will need to install just)

Installation

First install Rust. Then to install the package run:

sh cargo install python-project-generator

How to use

Create a new project

From your terminal run:

sh 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.

sh 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.

Pure Python Projects

Install the Python dependencies.

sh poetry install

Install the pre-commit hooks.

sh pre-commit install

PyO3 projects

First create a virtual environment and activate it.

sh python -m venv .venv . .venv/bin/activate

Install the dependencies and build the rust module.

sh just install

Install the pre-commit hooks.

sh pre-commit install

Now your project is ready to use.

Save custom default values

You can specify default values for many of the project options. For example to save a default creator:

sh python-project config creator "Wade Watts"

To see a full list of values that be set as defaults run:

sh python-project config --help

To view the current saved defaults:

sh python-project config show

To remove custom defaults:

sh python-project config reset