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.
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. Here’s what makes it special:
Full documentation on ReadTheDocs¶
Features¶
🔍 Fuzzy search for project names
🏢 Filter by workspace
📋 Multiple output formats (text, JSON, CSV)
📎 Clipboard integration
🎨 Rich terminal UI with color support
🔐 Secure token handling
⚡ Fast and efficient pagination
Quick Start¶
Installation¶
From PyPI¶
pip install py-launch-blueprint
From Source¶
git clone https://github.com/smorin/py-launch-blueprint.git
cd py-launch-blueprint
pip install -e ".[dev]" # Install with development dependencies
Direct Usage¶
You can also run the script directly:
python projects.py --help
Configuration¶
The tool supports multiple ways to provide your Py Personal Access Token (PAT), in order of precedence:
Command-line argument:
--tokenEnvironment variable:
PY_TOKENConfiguration file:
~/.config/py-launch-blueprint/.env
Setting Up Configuration File¶
Create the config directory:
mkdir -p ~/.config/py-launch-blueprint
Create
.envfile:
echo "PY_TOKEN=your_token_here" > ~/.config/py-launch-blueprint/.env
Set proper permissions:
chmod 600 ~/.config/py-launch-blueprint/.env
Usage¶
Basic Usage¶
# Search for projects
py-projects
# Filter by workspace
py-projects --workspace "My Workspace"
# Limit results
py-projects --limit 50
Output Formats¶
# JSON output
py-projects --format json
# CSV output
py-projects --format csv
# Copy to clipboard
py-projects --copy
# Save to file
py-projects --output projects.txt
Additional Options¶
# Show verbose output
py-projects --verbose
# Disable colors
py-projects --no-color
# Show help
py-projects --help
# Show version
py-projects --version
Error Codes¶
0: Successful execution
1: Configuration error
2: Authentication error
3: API error
4: Input/Output error
5: User interrupt
Table of Contents¶
- About Py Launch Blueprint
- Tasks Overview
- Tools Overview
- Tutorials Overview
- Reference Overview
- Contributing to Py Launch Blueprint
- GitHub Issue and PR Templates
- Starting point for new issue templates