Skip to main content

auto-gen-py-project

Python project generator — scaffolds production-ready repos from templates, with plugins, an interactive wizard, and optional tooling (Docker, GitHub Actions, pre-commit, venv).

CI PyPI version Python 3.12+ Platform License: MIT

Install

pip install --upgrade auto-gen-py-project

From source:

python -m pip install -e ".[dev]"

Show version

auto-gen-py-project version
# or
auto-gen-py-project --version

If the auto-gen-py-project command is not recognized, the scripts folder is not on PATH (can happen on Windows, macOS, or Linux). Use:

python -m auto_gen_py_project version

Then run python -m auto_gen_py_project doctor for OS-specific PATH fix instructions.

Supported platforms

OS Support Notes
Windows Yes PowerShell / CMD; use python -m … if Scripts is not on PATH
macOS Yes Terminal / zsh; same CLI and templates
Linux Yes Ubuntu and other distros; CI runs on Ubuntu

Requires Python 3.12+. CI tests all three OSes on Python 3.12 and 3.13.

Quick start

# Plain init: creates ./my-project/ with a simple Python library inside
auto-gen-py-project init

# Named root folder
auto-gen-py-project init --name CoolLib

# Explicit path (folder is created if missing)
auto-gen-py-project init ./services/api -n api -t library

auto-gen-py-project create
auto-gen-py-project new MyApp --template fastapi --docker
auto-gen-py-project list-templates
auto-gen-py-project doctor

Also available as: python -m auto_gen_py_project …

Commands

Command Description
init Create a simple Python project (creates the root folder; default ./my-project/)
create Interactive wizard
new NAME Create a project from a template
list-templates List templates / project types
install-template Install a template plugin (or local sample)
doctor Environment diagnostics
update Upgrade from PyPI
version Show version (1.3.2)
config Show / write user defaults
plugin list|install|remove Plugin management

Lockfiles (uv / poetry)

auto-gen-py-project new App -t library -m uv --lock
auto-gen-py-project init ./svc -n svc -t fastapi -m poetry --lock

Requires the uv or poetry binary on PATH. Soft-fails with a warning if missing.

Project types

library, cli, fastapi, flask, django, data-science, machine-learning, ai, computer-vision, rest-api, microservice, desktop, automation, async, pypi-package, jupyter

Configuration

User defaults (TOML / YAML / JSON), searched in the current directory, ~/.config/auto-gen-py-project/, and $HOME:

  • auto-gen-py-project.toml
  • auto-gen-py-project.yaml
  • auto-gen-py-project.json

Example:

[defaults]
author = "Ada Lovelace"
email = "ada@example.com"
license = "MIT"
python_version = "3.12"
package_manager = "pip"
generate_lock = false
ci_provider = "github-actions"
use_docker = false
use_git = true

Plugins

Third-party packages can expose entry points:

[project.entry-points."auto_gen_py_project.plugins"]
my = "my_pkg.plugin:MyPlugin"

[project.entry-points."auto_gen_py_project.templates"]
extra = "my_pkg.templates:get_root"
# Local example plugins (see examples/)
pip install -e ./examples/auto-gen-py-project-fastapi
pip install -e ./examples/auto-gen-py-project-django
pip install -e ./examples/auto-gen-py-project-ai
auto-gen-py-project list-templates
auto-gen-py-project new Demo -t fastapi-extended
auto-gen-py-project plugin list

Template hints

Pass a short description to pick a matching built-in template by keywords (no external services):

auto-gen-py-project new Shop --describe "FastAPI inventory service with Docker"

Documentation

Development

python -m pip install -e ".[dev]"
pytest

Git Flow branches: main, develop, feature/*, release/*, hotfix/*.

License

MIT — see LICENSE.md.

Metadata

Release files for auto-gen-py-project 1.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for auto-gen-py-project 1.3.2
File Size Uploaded Provenance
auto_gen_py_project-1.3.2.tar.gz 30.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for auto-gen-py-project 1.3.2
File Interpreter ABI Platform
auto_gen_py_project-1.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 69.9 kB

Release files / auto_gen_py_project-1.3.2.tar.gz

Download URL auto_gen_py_project-1.3.2.tar.gz
Size 30.8 kB
Tags Source
SHA-256 checksum
How to use checksums
864cab5e60aba75b3f46a22c171e6391aec28ebb25bff39f3af5578db0801f72
BLAKE2b-256 checksum
How to use checksums
7ad1fd3699b0b66be66a1e4096d8e206f7bf0cf2a673abcd76ee7a09944e7c74
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.14

Release files / auto_gen_py_project-1.3.2-py3-none-any.whl

Download URL auto_gen_py_project-1.3.2-py3-none-any.whl
Size 39.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9bf8d2cd95d774844e1b55cbe60970f12e0e97618d8672ea81a1f56ae312d6e9
BLAKE2b-256 checksum
How to use checksums
c219453ac08be95f0e7ccdea8db69783126a00f4cdc7956ce956156249c236d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.14

Security for auto-gen-py-project 1.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page