114 releases (stable)
new 1.18.0 | Nov 22, 2024 |
---|---|
1.16.1 | Oct 28, 2024 |
1.1.0 | Jul 29, 2024 |
1.0.25 | Mar 29, 2024 |
0.6.10 | Nov 28, 2023 |
#7 in Command line utilities
1,311 downloads per month
295KB
8K
SLoC
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
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
Python project with Rust modules included packages
- 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)
Docs
If you chose to include docs then additional dev packages will be included for docs.
- mkdocs for creating the docs
- mkdocs-material for theming the docs
- mkdocstrings for automatically creating API docs
Additionally the pypi_publish.yml
workflow will also be setup to deploy the doc on release.
Installation
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.
How to use
Create a new project
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
Options
-
License
Choose from MIT, Apache 2, or no license.
-
Python Version
This will be the default Python version used. For example when releasing the project this is the version of Python that will be used.
-
Minimum Python Version
This is the minimum supported Python version for the project. This is also the version that is used for ruff's upgrade target version.
-
Python Versions for Github Actions Testing
Versions listed here will be the versions used for testing in CI.
-
Project Manager
Specifies how project dependencies and builds should be handled
-
Application or Library
Choosing application will create
main.py
and__main__.py
files. Choosing library will omit these files. -
Async Project
Selecting yes for this option will add pytest-asyncio to the dev dependencies. Additionally if the project is an application the
main
function will be maid async. -
Max Line Length
This controls how long the ruff formatter will use for line wrapping.
-
Use Dependabot
Dependabot can be used to keep dependencies up to date. If enabled dependabot will automatically create PRs to update dependencies when they are available.
-
Dependabot Schedule
When dependabot is enabed the schedule controls how often dependabot will check for updates and create PRs.
-
Use Continuous Deployment
This will create a GitHub Action to deploy the project to PyPI when a new release is created. Note that for this to work you will need to setup a trusted publisher in PyPI with a workflow name of pypi_publish.yml.
-
Release Drafter
Choosing yes will create a release drafter action automatically adds the tile of the PR, who created it, and it's PR number to a draft GitHub release. By default the release will get a patch version update. Adding a
bug
label will get a patch version update and add it to theBug
section of the release notes. Adding anenhancement
label to a PR will create a release with a minor version bump, and abreaking-change
label will create a major version bump. The draft release will get the release version tag for the highest label applied to the merged PRs in the release. PRs can be excluded from the release notes by applying askip-changelog
label to the PR. -
Use Multi OS CI
Choosing yes will setup CI to run tests on Linux, Mac, and Windows. If no is chosen tests will only run on Linux in CI.
-
Include Docs
Choosing yes will add additional packages and base setup for creating documents with mkdocs.
-
Docs Site Name
This quesion will only show if you chose
yes
forInclude Docs
. This value sets the site name field for mkdocs. -
Docs Site Description
This quesion will only show if you chose
yes
forInclude Docs
. This value provides a a description of the repo to use in the docs. -
Docs Site URL
This quesion will only show if you chose
yes
forInclude Docs
. This is the URL where the docs will be hosted. -
Docs Locale
This quesion will only show if you chose
yes
forInclude Docs
, and controls the language of the docs. -
Repo Name
This quesion will only show if you chose
yes
forInclude Docs
. This is the name of the repo the docs are referencing. For example in this repository the repo name would besanders41/python-project-generator
. -
Repo URL
This quesion will only show if you chose
yes
forInclude Docs
. This is URL for the repo the docs are referencing. For example in this repository the repo url would behttps://github.com/sanders41/python-project-generator
-
Extra Python Dependencies
These are extra packages you want to include in the project that are not provided by default. For example specifying
fastapi, camel-converter
here will inculde these two packages in the dependencies. If the project is an application the version will be pinned to the latest release of the packages, and if it is a library the latest release will be used for the minimum version. If you would like to specify a specific version instead you can by specifying the version with an@
. For examplefastapi@0.115.0, camel-converter@4.0.0
. When creating an appliction FastAPI will be pinned to0.115.0
and Camel Converter will be pinned to4.0.0
, or if creating a library these versions will be used for the minimum version. -
Extra Python Dev Dependencies
These are extra packages you want to include in the project's dev dependencies that are not provided by default. For example specifying
pytest-xdist
here will include this package in the dev dependencies. If you would like to specify a specific version instead of checking for the latest you can by specifying the version with an@
. For examplepytest-xdist@3.6.1
.
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 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 Python dependencies when using uv.
First create a virtual environment and activate it.
uv venv
. .venv/bin/activate
Next create a lock file
uv lock
Then install the dependencies
uv sync --frozen
Install the pre-commit hooks.
pre-commit install
PyO3 projects
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.
Save custom default values
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
Information
just
just allows you to add project specific commands to the project that can be run from the command line. It is very similar to make but has the advantage of being cross platform compatable and purposee build for running commands.
As an example, if you have the following in the justfile
(this is included with the default file
generated by this project):
@lint:
echo mypy
just --justfile {{justfile()}} mypy
echo ruff
just --justfile {{justfile()}} ruff
echo ruff-format
just --justfile {{justfile()}} ruff-format
@mypy:
uv run mypy meilisearch_python_sdk tests
@ruff:
uv run ruff check .
@ruff-format:
uv run ruff format meilisearch_python_sdk tests examples
Then you can run mypy
, ruff
check, and ruff
format with:
just mypy
just ruff
just ruff format
You can also run all 3 with 1 just
command:
just lint
pre-commit
pre-commit runs linting and formatting on your code (as defined in the provided .pre-commit-config.yaml file) every time you make a commit to your code. If any of the lints fail pre-commit will cancel the commit. When possible, pre-commit will also automatically fix any errors that fail. For example pre-commit can automatically apply changes that fail ruff fromatting. pre-commit caches information and only runs on files that have changed so it is fast and doesn't slow down your work flow will preventing you from forgetting to run checks.
Contributing
If you are interested in contributing please see our contributing guide
Dependencies
~14–26MB
~392K SLoC