Skip to main content

A professional Python project bootstrapper CLI supporting multiple frameworks.

Project description

setupci

PyPI version Tests Python Versions License: MIT

setupci is an interactive Python CLI tool to bootstrap project structures for various Python frameworks. Stop setting up boilerplate โ€” just run one command and start coding.


๐Ÿ“ฆ Installation

pip install setupci

๐Ÿš€ Usage

Navigate to your project directory and run:

setupci init .

You will be asked:

  1. Which framework? โ€” FastAPI, Flask, Django, or General Python
  2. Which project type? โ€” Backend (professional) or Simple (basic)

That's it! Your project structure will be generated instantly.


๐Ÿ—‚๏ธ Generated Structures

โšก FastAPI โ€” Backend

app/
โ”œโ”€โ”€ main.py         # FastAPI app + CORS + routers
โ”œโ”€โ”€ core/config.py  # Pydantic settings (reads from .env)
โ”œโ”€โ”€ api/
โ”‚   โ”œโ”€โ”€ router.py
โ”‚   โ””โ”€โ”€ endpoints/items.py   # CRUD routes
โ”œโ”€โ”€ models/item.py  # SQLAlchemy model
โ”œโ”€โ”€ schemas/item.py # Pydantic schemas
โ””โ”€โ”€ db/session.py   # Database engine + session
requirements.txt
Dockerfile
.env.example

๐ŸŒถ๏ธ Flask โ€” Backend

app/
โ”œโ”€โ”€ __init__.py     # Application factory
โ”œโ”€โ”€ config.py       # Config class
โ”œโ”€โ”€ api/items.py    # Blueprint with CRUD routes
โ””โ”€โ”€ models/item.py  # SQLAlchemy model
wsgi.py
requirements.txt
Dockerfile
.env.example

๐ŸŽธ Django โ€” Backend

config/
โ”œโ”€โ”€ settings.py     # Uses django-environ for .env
โ”œโ”€โ”€ urls.py
โ”œโ”€โ”€ wsgi.py
โ””โ”€โ”€ asgi.py
apps/
โ””โ”€โ”€ items/          # Sample DRF CRUD app
    โ”œโ”€โ”€ models.py
    โ”œโ”€โ”€ views.py
    โ”œโ”€โ”€ serializers.py
    โ””โ”€โ”€ urls.py
manage.py
requirements.txt
Dockerfile
.env.example

๐Ÿ General Python โ€” Backend

src/
โ”œโ”€โ”€ __init__.py
โ””โ”€โ”€ main.py
tests/
โ””โ”€โ”€ test_main.py
pyproject.toml
README.md

๐Ÿค Contributing

Contributions are welcome! See CONTRIBUTING.md to get started.


๐Ÿ“ License

This project is licensed under the MIT License.


๐Ÿ”— Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

setupci-0.1.1.tar.gz (15.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

setupci-0.1.1-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

Details for the file setupci-0.1.1.tar.gz.

File metadata

  • Download URL: setupci-0.1.1.tar.gz
  • Upload date:
  • Size: 15.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for setupci-0.1.1.tar.gz
Algorithm Hash digest
SHA256 11ebdb0f60cb8c8f8eb552a051721c13a3fb50bc1687d2bb1be1675c90bf2ab0
MD5 982583e3811d2bb506cceb6521813057
BLAKE2b-256 ec60b6151bc29811b5147796935306487f762a962619febd48ca6fab1cee0421

See more details on using hashes here.

File details

Details for the file setupci-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: setupci-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 38.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.2

File hashes

Hashes for setupci-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 68256693f7b07384bc1de8f276f75618271b5b7cd5b7ce5f1c25605399c02286
MD5 c77e01bd1f1753c5262b711ac0e86df7
BLAKE2b-256 baf060f2d2dab29faeafc30138fa0f342f1dcf717a9d6f744e9f8c5934f2c51b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page