BoilrPy is a Python project automation tool that simplifies the process of creating new Python projects. It generates a standardized project structure, including essential files and configurations, allowing developers to quickly start working on their Python projects.
Installation
You can install BoilrPy directly from PyPI:
pip install boilrpy
📦 Dependency Managers
Boilrpy supports multiple Python dependency managers, each with its own strengths:
Supported Managers
| Manager | Speed | Lock File | Use Case | Installation |
|---|---|---|---|---|
| pip | ⭐⭐⭐ | ❌ | Simple projects, beginners | Pre-installed with Python |
| poetry | ⭐⭐ | ✅ | Professional projects, teams | pipx install poetry |
| uv | ⭐⭐⭐⭐⭐ | ✅ | Modern projects, speed-focused | pip install uv |
| conda | ⭐ | ❌ | Data science, scientific computing | Download from anaconda.com |
Quick Comparison
- 🐍 pip: Traditional, universal, simple
- 📦 poetry: Modern, professional, reproducible
- ⚡ uv: Blazingly fast (10-100x faster than pip)
- 🔬 conda: Best for data science and non-Python dependencies
For detailed information, see Dependency Managers Guide.
Quick Start
Create a new Python project with boilrpy:
from boilrpy import create_project
create_project(
name="my_awesome_project",
version="0.1.0",
license="MIT",
dependencies_manager="poetry" # or "pip", "uv", "conda"
)
Or use the command-line interface:
boilrpy
Features
- Create a new Python project with a standardized structure
- Generate essential files (LICENSE, .gitignore, README.md, etc.)
- Initialize a Git repository
- Set up dependency management (Poetry or pip)
- Create a Dockerfile and .dockerignore
- Support for multiple license types
- Configurable project
Usage
To create a new Python project using the CLI, run:
boilrpy
# Check installed dependency managers
boilrpy --check-deps
Follow the prompts to configure your project. You'll be asked for:
- Project name
- Version
- License type
- Dependency management preference (Poetry or pip)
- And more...
Project Structure
boilrpy generates the following project structure:
Without flask
your_project/
├── Dockerfile (if using Docker)
├── .dockerignore (if using Docker)
├── .pylintrc (if using pylint)
├── .gitignore
├── LICENSE
├── README.md
├── CHANGELOG.md
├── pyproject.toml (if using Poetry)
├── poetry.lock (if using Poetry)
├── requirements.txt
├── main.py (project entrypoint)
└── tests/
└── __init__.py
With flask
your_project/
├── Dockerfile (if using Docker)
├── .dockerignore (if using Docker)
├── .pylintrc (if using pylint)
├── .gitignore
├── .env
├── LICENSE
├── README.md
├── CHANGELOG.md
├── pyproject.toml (if using Poetry)
├── poetry.lock (if using Poetry)
├── requirements.txt
├── app.py (flask entrypoint)
├── static/ (assets folder)
│ └── css/
│ | └── style.css
│ └── js/
│ └── script.js
├── templates/ (html files)
│ └── base.html
| └── index.html
└── tests/
└── __init__.py
Run this command to launch server:
flask run
By default your flask app is accessible at this address: http://127.0.0.1:5000 (see app.py)
This configuration is for development
Configuration
Boilrpy uses sensible defaults, but you can customize the project creation process by answering the prompts during project creation.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Support
If you encounter any problems or have any questions, please open an issue on the GitHub repository.
Links
Metadata
Release files for boilrpy 0.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| boilrpy-0.8.0.tar.gz | 21.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| boilrpy-0.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 53.1 kB
Release files / boilrpy-0.8.0.tar.gz
| Download URL | boilrpy-0.8.0.tar.gz |
|---|---|
| Size | 21.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dbe33a7260351eeee8a2a00222e0f1271d58f9d88bf9d6ee764470e41ab8467a
|
|
BLAKE2b-256 checksum How to use checksums |
025e9f456a6801e3e2a20cd0742c309e7b0d82f54625db8e4ab6d324558cd7a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.7
|
Release files / boilrpy-0.8.0-py3-none-any.whl
| Download URL | boilrpy-0.8.0-py3-none-any.whl |
|---|---|
| Size | 31.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
287f24d6fbfd631312ae03ff534ffd35d330a5dfe71ca0fc738215d3255748c4
|
|
BLAKE2b-256 checksum How to use checksums |
432a99444f87cfb2ae65ceee008b328fa70cfe5cb1addd9269660d1b79fdfc20
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.7
|