boilrpy 0.6.0

A python development boilerplate generator

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

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",
    use_poetry=True
)

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

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

• GitHub: https://github.com/tabodino/boilrpy
• PyPI: https://pypi.org/project/boilrpy/