Skip to main content

CLI tools for interacting with Py, including project search functionality

Project description

PyPI version Python versions CI codecov License: MIT Ruff uv Conventional Commits

Py Launch Blueprint: A Production-Ready 🐍 Python Project Template with Integrated Best Practices

Py Launch Blueprint is a comprehensive Python project template that eliminates setup friction by providing a pre-configured development environment with carefully selected tools for linting, formatting, and type checking. It includes an annotated CLI example and detailed documentation explaining each tool choice and configuration decision, making it an ideal starting point for professional Python projects.

Py Launch Blueprint Logo

Why Choose Py Launch Blueprint?

Py Launch Blueprint eliminates the setup friction in Python projects by providing a production-ready template with carefully curated tools and best practices.

Full documentation on ReadTheDocs

🚀 Key Features

Zero-config development environment with type safety built in.

✨ Features TLDR

  • 🛠️ Dev Tools: Ruff (linting/formatting), ty (type checking, Astral), lefthook (hooks), commitlint
  • 🔒 Security: gitleaks (commit/push), TruffleHog (CI), bandit (pre-push + CI), CodeQL
  • 🧠 AI Ready: AGENTS.md + CLAUDE.md, default configs for Cursor, Windsurf, Claude Code
  • 💪 Production: Python 3.12+, uv + uv_build, PEP 735 dependency-groups, static version
  • 🚀 DX - Developer Experience: VS Code DevContainer, sensible defaults, quality documentation
  • 🔄 CI/CD: GitHub Actions workflows, release-please version bumps, OIDC trusted publishing

Quick start

git clone https://github.com/smorinlabs/py-launch-blueprint.git
cd py-launch-blueprint
make hook-check          # verify toolchain (lefthook/gitleaks/bun/uv/...)
scripts/install-bun.sh
scripts/install-lefthook.sh
scripts/install-gitleaks.sh
uv sync --group dev      # PEP 735 dev tools
bun install              # commitlint deps
just check               # full quality pipeline

Install as a tool: uvx --from py-launch-blueprint py-projects (uvx needs --from because the distribution name differs from the console-script name) or pip install py-launch-blueprint && py-projects.

See AGENTS.md for the canonical command set, .github/CONTRIBUTING.md for the daily workflow, and RELEASE.md for the release flow.

Starting a new project from this template? If you use Claude Code or any agent that reads AGENTS.md, just say "create a new Python project from py-launch-blueprint" — the skill/ skill will walk you through gh repo create --template, identity collection, just init rebrand with preview, and an optional handoff to just post-init for publishing/Codecov/ReadTheDocs setup. For humans without an agent: the skill is also a copy-pasteable runbook.

🎯 Perfect For

Teams and professionals needing maintainable, type-safe Python projects following best practices.

Complete Feature List

Development Tools

  • Bootstrap dependency check and install with make: Execute common development tasks with simple commands, standardizing workflows across team members.

  • Command running with just: Define and run project-specific commands with a modern Make alternative, simplifying complex operations with clear syntax.

  • Linting with ruff: Catch errors and enforce code style at lightning speed (10-100x faster than traditional linters), reducing waiting time and improving developer productivity.

  • Type checking with mypy: Prevent type-related bugs before they occur, making your codebase more robust and easier to maintain as it grows.

  • Formatting with ruff: Ensure consistent code style across your project automatically, eliminating style debates and pull request revision cycles.

  • Pre-commit hooks with pre-commit: Enforce quality standards before code enters your repository, preventing bad code from ever being committed and reducing technical debt.

  • TOML formatting and validation with taplo: Verify Toml files for syntax correctness, maintain consistent configuration files, ensuring readability and avoiding syntax errors in critical project settings.

  • YAML validation with yamllint: Verify YAML files for syntax correctness, preventing configuration errors and deployment failures.

Project Structure & Management

  • Project configuration with pyproject.toml: Organize all project settings in one standardized location, simplifying maintenance and configuration.

  • Dependency groups separation: Organize dependencies into main, dev, and doc categories, preventing bloated installations and clarifying requirements as part of pyproject.toml configuration.

  • Dependency management with uv: Install and manage packages at blazing speed (100x faster than pip/poetry), dramatically reducing environment setup time.

  • Build system with uv_build: Build wheel and source distributions with uv's build backend and uv build.

  • Versioning with explicit project metadata: Keep release tags aligned with the static version in pyproject.toml for predictable package metadata.

  • Copyright license automation: Automatically add license headers to all files, ensuring legal compliance without manual effort.

Documentation

  • Documentation with sphinx + MyST: Generate comprehensive documentation that supports both reStructuredText and Markdown, improving contributor accessibility.

  • Read the Docs integration: Deploy documentation automatically, providing instant hosting and versioning for your project's documentation.

  • Changelog management with cog: Track and communicate changes effectively to users and team members, improving project transparency and adoption.

Testing & Quality Assurance

  • Testing framework with pytest: Write and run tests with a modern, powerful testing framework that supports fixtures and parameterization.

  • CI/CD with GitHub Actions: Automatically test, build, and deploy your project on multiple Python versions, catching compatibility issues early.

  • Matrix testing with GitHub Actions: Run tests across multiple Python versions and operating systems, ensuring broad compatibility.

  • Simplified debugging info with just debug-info: Automatically collect and format essential system, tool, and dependency information for streamlined bug reporting via a simple command.

GitHub Integration

  • Pull request template: Guide contributors through the PR process with structured information requirements, improving submission quality.

  • Issue templates (Feature, Bug, Documentation): Standardize issue reporting with appropriate fields for each type, gathering all necessary information upfront.

  • Automated contributor recognition with contributors-please: Automatically update contributor lists, acknowledging all project participants without manual tracking.

  • Conventional commits enforced with commitlint: Enforce structured commit messages so release-please can automate changelog generation and version bumps.

  • Security policy: Establish clear vulnerability reporting procedures, promoting responsible disclosure and faster security fixes.

  • Code of conduct: Set community behavior expectations, fostering an inclusive and respectful project environment.

  • Contributing guidelines: Provide clear instructions for contributors, reducing friction for new participants.

  • Automated dependency security scanning with codeql: Detect vulnerable dependencies automatically, protecting your users from known security issues.

  • CLA (Contributor License Agreement) check via CLA Assistant: Ensure all contributors have signed appropriate licensing agreements, protecting the project legally.

IDE Integration

  • VS Code integration: Provide optimized settings and configurations for Visual Studio Code, enhancing developer productivity.

  • PyRight configuration: Enable accurate, real-time type checking in the editor, catching errors before running tests.

  • Editor extensions recommendations: Suggest optimal VS Code extensions automatically, standardizing the development environment.

AI Integration

  • AI assistance with common agents Cursor, Windsurf, Claude Code, Codex: Support popular AI coding assistants enabling AI-powered development.

  • Cursor Rules configuration: Optimize Cursor AI assistant for your specific project structure, improving suggestion relevance.

  • Windsurf Rules configuration: Configure Windsurf IDE to understand your project architecture, enhancing code generation quality.

Communication & Notifications

  • Slack integration for PRs and issues: Send automated notifications to Slack when PRs or issues are opened/closed, keeping the team informed.

  • PR reminder notifications: Ping relevant team members on Slack for PR reviews, reducing review cycle times.

Start your next Python project with confidence, knowing you're building on a foundation of best practices and modern development tools.

Full documentation on ReadTheDocs including how to run

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_launch_blueprint-1.1.3.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_launch_blueprint-1.1.3-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

Details for the file py_launch_blueprint-1.1.3.tar.gz.

File metadata

  • Download URL: py_launch_blueprint-1.1.3.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for py_launch_blueprint-1.1.3.tar.gz
Algorithm Hash digest
SHA256 991d71f6483f5a3fe2f67fa675b87c0148d9c8e3e67cb7aec7f55efe9502d327
MD5 e7786184f37631fe0d627afd0529fb71
BLAKE2b-256 6f6828b1eb5c28aca902fe5d183904ce53dd5c2c1c58bcd620b533e7d6c71363

See more details on using hashes here.

File details

Details for the file py_launch_blueprint-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: py_launch_blueprint-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for py_launch_blueprint-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 233a8edb316ab172a4b24df57f8e3be33746434a6039cb6d874766a5d2c96998
MD5 4055cac08fdc537455bca1e4fb7c90db
BLAKE2b-256 e0a4ddbebfb50d1375fd736fd0575d4e3456d591a383d0d9f59ddfc2c7cc2e4e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page