Skip to main content

CLI tool to quickly generate Flask apps

Project description

QuickFlask

QuickFlask is a CLI tool designed to help you create modular, functional Flask applications in seconds. I love Flask, but I often found myself writing the same boilerplate code repeatedly. To save time, I created QuickFlask. This tool will save you time and effort, allowing you to focus on building your application rather than setting up the initial structure. It adheres to the DRY (Don’t Repeat Yourself) principle.

Installation

To install QuickFlask, run:

pip3 install quick-flask

Usage

Once installed, you can create a new Flask project by running:

quickflask

Options:

  • --name (Required): The name of your Flask application.

Example:

quickflask --name my_flask_app

Running Your Flask App

After creating your project, navigate into the directory:

cd my_flask_app

Set up a virtual environment (recommended):

python3 -m venv venv
source venv/bin/activate  # On Windows: .\venv\Scripts\activate

Install dependencies:

pip install -r requirements.txt

Run the Flask app:

python app.py

Your application will be accessible at http://127.0.0.1:5000/.

Features

  • Generates a structured Flask project with blueprints and templates.
  • Automatically sets up templates and API routes.
  • Saves time by eliminating repetitive boilerplate code.

Contributing

Feel free to open issues or submit pull requests to improve QuickFlask. Contributions are always welcome!

License

This project is licensed under the MIT License. See LICENSE for details.

Change Log

For a detailed list of changes and version history, please see the CHANGELOG.md file.

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

quick_flask-1.1.0.tar.gz (232.2 kB view details)

Uploaded Source

Built Distribution

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

quick_flask-1.1.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file quick_flask-1.1.0.tar.gz.

File metadata

  • Download URL: quick_flask-1.1.0.tar.gz
  • Upload date:
  • Size: 232.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for quick_flask-1.1.0.tar.gz
Algorithm Hash digest
SHA256 a43f7fbcc66d01ef4efae2a2c80d90d715eab07dec4eb2a6e196a668d3719db6
MD5 878be0e1760c6dfc1deaa3f7a56a1260
BLAKE2b-256 771179762fc4b3f73bf8237859610a83557dd44efa8e6072bc1b3763ea8e9c4d

See more details on using hashes here.

File details

Details for the file quick_flask-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: quick_flask-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for quick_flask-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 11022cd6863800d9b0ac409f7f91d454e45eb57c8d2f0a6eb39023c6eca89349
MD5 3a71e5bf422bbe53a31a7c79e1cf7e08
BLAKE2b-256 00c5e6cb74b6f3a17e00512407019dad00859b3a2252d66663741cf9bfdebad9

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