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.2.tar.gz (17.2 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.2-py3-none-any.whl (40.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: setupci-0.1.2.tar.gz
  • Upload date:
  • Size: 17.2 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.2.tar.gz
Algorithm Hash digest
SHA256 ed9353e6638649158d3951ee34cd7a88ba80cd71256f4edd3dd2c9c7eb245a06
MD5 7c44d233d92c67060ed8699c4feec675
BLAKE2b-256 95153f0eb9d9870305559b443d6f5f1d829cdac2c6085697f205f4574e620b9a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: setupci-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 40.4 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f799f5ee4dbd5c4e7654e164fcff6fa75d2c3834b0a3b305cc4a9f1c5f76f9db
MD5 6e12e228a49f219a3884af64bda197c3
BLAKE2b-256 a879d6bef6edbe6ee8814d38c95250184fcc0cc3280e6f6e8cb1b10ce25a678b

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