Skip to content

Commit

Permalink
Merge pull request #13 from smorin/feature/project-benefits
Browse files Browse the repository at this point in the history
Updated project benefits
  • Loading branch information
smorin authored Jan 23, 2025
2 parents fad19b3 + e8a68ca commit 2a21903
Showing 1 changed file with 33 additions and 5 deletions.
38 changes: 33 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,39 @@

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.

Will use either
- https://copier.readthedocs.io/en/latest/
OR
- https://github.com/cruft/cruft
- https://github.com/cookiecutter/cookiecutter
## 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:

### πŸš€ Key Features

- **Zero Configuration Setup**: Get started immediately with pre-configured development tools
- **Type Safety First**: Built-in MyPy configuration and VS Code integration for robust type checking
- **Modern Development Tools**:
- ⚑ Ruff for lightning-fast linting and formatting
- 🎨 Black for consistent code styling
- πŸ” Pre-commit hooks for code quality enforcement
- πŸ“ Type checking with MyPy and Pylance

### πŸ’ͺ Production Ready
- **Python 3.10+ Support**: Leverages modern Python features
- **Dependency Management**: Uses `uv` for fast, reliable package management
- **CI/CD Ready**: Includes GitHub Actions workflows
- **Comprehensive Testing**: Pre-configured test setup with best practices

### πŸ› οΈ Developer Experience
- **VS Code Integration**: Curated set of recommended extensions
- **Intelligent Defaults**: Optimized settings for common development tasks
- **Clear Documentation**: Detailed explanations for all tool choices and configurations
- **Git Hooks**: Automated code quality checks before commits

### 🎯 Perfect For
- Teams wanting a standardized Python development environment
- Projects requiring maintainable, type-safe code
- Developers who value clean, consistent code style
- Anyone looking to adopt Python best practices from day one

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

## Contributing

Expand Down

0 comments on commit 2a21903

Please sign in to comment.