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

Flag style (recommended on every OS — Windows, macOS, Linux):

# Create project files in the current folder
auto_gen_py_project --init --force

# Or into a specific folder
auto_gen_py_project --init --path ./myapp --name myapp --force

auto_gen_py_project --version
auto_gen_py_project --doctor
auto_gen_py_project --list-templates
auto_gen_py_project --create

Also available as python -m auto_gen_py_project … and hyphenated auto-gen-py-project ….

Subcommands still work:

# 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 / --init Create a simple Python project in a folder (--init = current/specific folder)
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.4)
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.4

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.4
File Size Uploaded Provenance
auto_gen_py_project-1.3.4.tar.gz 31.7 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 71.6 kB

Release files / auto_gen_py_project-1.3.4.tar.gz

Download URL auto_gen_py_project-1.3.4.tar.gz
Size 31.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f24521a29661966cbdc428fca7b7b3fd19977c1e868b0aa9a1b3ea6765b86259
BLAKE2b-256 checksum
How to use checksums
754bf37b789f718614b373d6eba684123d73e08c049f1f5fd12ed60da9a43fd6
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.4-py3-none-any.whl

Download URL auto_gen_py_project-1.3.4-py3-none-any.whl
Size 39.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
183cc0e7f40a6cd9345b778084d4966728aac4c3581d7eac3fcff817d1fa8e25
BLAKE2b-256 checksum
How to use checksums
442a751b619779b6e5fd0cf392e6f45d2779e2e4aa9e417a13f14fb595721f30
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.4

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