https://github.com/dimanu-py/instant-python
Instant boilerplate generation for Python projects
https://github.com/dimanu-py/instant-python
project-generator pypi-package python
Last synced: about 1 year ago
JSON representation
Instant boilerplate generation for Python projects
- Host: GitHub
- URL: https://github.com/dimanu-py/instant-python
- Owner: dimanu-py
- License: apache-2.0
- Created: 2024-11-15T08:20:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-08T19:25:54.000Z (about 1 year ago)
- Last Synced: 2025-06-08T19:34:05.833Z (about 1 year ago)
- Topics: project-generator, pypi-package, python
- Language: Python
- Homepage: https://pypi.org/project/instant-python/
- Size: 1.16 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
⚡️ Instant Boilerplate for Python Projects ⚡️
Start your Python project right away
Getting Started •
Guide •
Contributing
## Installation
Install `instant-python` from PyPI:
```bash
# With pipx
pipx install instant-python
```
```bash
# With pip in pyenv
pip install instant-python
```
## Documentation
The official documentation is available at [dimanu-py.github.io/instant-python](https://dimanu-py.github.io/instant-python).
We recommend to visit the page to understand the features and how to use the library.
Additionally, you can also run the help command to get started:
```bash
ipy --help
```
## Features
With `instant-python` there is a lot of features you can customize easily so you can start coding on your project
as soon as possible. An overview of the features is given below, but you can find a more detailed explanation in the
[documentation](https://dimanu-py.github.io/instant-python/guide/features/).
- Project slug: Configure the name of the main folder of your project.
- Source name: Configure the name of the source code folder of your project.
- Description: Include a description about your project.
- Version: Set the initial version of your project.
- Author: Set the author of the project.
- License: Choose between _MIT_, _Apache_ or _GPL_ licenses to set your project.
- Python version: Select the Python version you want to use for your project between versions 3.13 to 3.10.
- Dependency manager: Choose between _uv_ or _pdm_ dependency managers.
- Git: configure your project as a git repository automatically.
- Default templates: select your project template between Domain Driven Design, Clean Architecture or Standard Project to
automatically generate your project folders and files.
- Out of the box implementations: include some boilerplate and implementations code that will help you to start your project faster.
Some of the most popular implementations are value objects, domain error modelling, makefile and Async SQL Alchemy.
- Dependencies: install dependencies automatically in your project.