Skip to main content

A python project structure generator

Project description

SCPYGEN ๐Ÿš€

V1.2.1

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.1.tar.gz (7.6 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.1-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: scpygen-1.2.1.tar.gz
  • Upload date:
  • Size: 7.6 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.1.tar.gz
Algorithm Hash digest
SHA256 e335d67a09f2f34ff49a6705853245673b4eb3433d43c7e93854b5a92d232578
MD5 b287fa5561f463c2c69f1a7e9ac94b21
BLAKE2b-256 23629e12d7ac035ad1416d9f4cc4ecbe8bc9705201643688103057727dcbb1ad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: scpygen-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 9.6 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6d149de4df5d375dbef78af2813aad9a9a5f53dffba0e2e6ee190788004eff3d
MD5 46e056a871de63357483f04d7354645c
BLAKE2b-256 1f8bc7e8d94ffc7f6c3415228c6dbbdc5ac08d464d94e9089fe8549fdaa3501e

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