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.1.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.1-py3-none-any.whl (236.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: quick_flask-1.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 7fb8cdf7f95fcffcbb06f79444efe3dfbb4ec7156f35e25d9824a49eec7c7794
MD5 f8efd4a068ae0cdef6ae76574b9bf392
BLAKE2b-256 9f96bbf00c08e6b1955a584751ae152d6b17153939c8c86070668bd4fa6efe11

See more details on using hashes here.

File details

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

File metadata

  • Download URL: quick_flask-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 236.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 08f8b80611528ec84e965abcb1929666ecf6c78a2814ccc65a013af9d7b126c3
MD5 af0bd3fcda098cff559b5b4825b22a6d
BLAKE2b-256 a1631d0e1c6a8fde26eeb7946c5e00a0f65a79532587ece7a172cbd0b3027b06

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