Skip to main content

A python project structure generator

Project description

SCPYGEN ๐Ÿš€

SCPYGEN is a Python CLI tool that instantly generates production-ready Flask project skeletons. Whether you need a minimal API or a full-stack Flask app (with templates, static files, and blueprints), SCPYGEN saves you time creating your project.

Features โœจ

  • Interactive CLI: Choose between a Flask API or a full-stack Flask app with a single command.
  • Best Practices: Projects include blueprints, config, models, migrations, .env, and more.
  • Customizable: Generated code is modular and easy to extend.
  • Fast Start: Go from zero to a working Flask project in seconds.

Installation โš™๏ธ

Install via pip:

pip install scpygen

Usage ๐Ÿ–ฅ๏ธ

Run the CLI in your terminal:

scpygen

Youโ€™ll be prompted to choose:

1: Flask API Skeleton (RESTful, no frontend)
2: Flask Full Stack Application (with templates, static, and database models)

Then enter your project name. scpygen will generate a new folder with all required files and folders.

Example Output Structure

For a Flask API Skeleton:

my-flask-api/
โ”œโ”€โ”€ run.py
โ”œโ”€โ”€ requirements.txt
โ”œโ”€โ”€ .env
โ”œโ”€โ”€ api/
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ config/
โ”‚   โ”œโ”€โ”€ models/
โ”‚   โ”œโ”€โ”€ routes/
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ tests/
โ””โ”€โ”€ ...

For a Full Stack Flask App:

my-flask-app/
โ”œโ”€โ”€ run.py
โ”œโ”€โ”€ requirements.txt
โ”œโ”€โ”€ .env
โ”œโ”€โ”€ app/
โ”‚   โ”œโ”€โ”€ __init__.py
โ”‚   โ”œโ”€โ”€ templates/
โ”‚   โ”œโ”€โ”€ static/
โ”‚   โ”œโ”€โ”€ models/
โ”‚   โ”œโ”€โ”€ routes/
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ tests/
โ””โ”€โ”€ ...

Change Log ๐Ÿ“„

You can view the Change Log HERE.

License ๐Ÿชช

This project is licensed under the MIT License - see the LICENSE file for details.

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

scpygen-1.2.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

scpygen-1.2.0-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file scpygen-1.2.0.tar.gz.

File metadata

  • Download URL: scpygen-1.2.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for scpygen-1.2.0.tar.gz
Algorithm Hash digest
SHA256 f3c41c5696a23ee3d333aa312f628c3e8086b1786febb5860bdd6010036c483e
MD5 938e850adc4e1e2a29a3764977bf103e
BLAKE2b-256 5069da707535bbccfcf6dec7c8dadd4d532ca78f9d7092847f5c6939cec46492

See more details on using hashes here.

File details

Details for the file scpygen-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: scpygen-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for scpygen-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e1729d0f0320867d71efbeab80310df99c1d63f96ca37482cd1a92d75496f848
MD5 be2f119c4f176d5a77a3f8ba4d7077d1
BLAKE2b-256 39bb3a28701a2b15b3e1a3fe7cdedf4613b90d03a1b60c1bd562063dfafe217c

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