Metadata-Version: 2.2
Name: quick-flask
Version: 1.1.2
Summary: CLI tool to quickly generate Flask apps
Home-page: https://github.com/adimail/quickflask
Author: Aditya Godse
Author-email: adimail2404@gmail.com
Project-URL: Bug Reports, https://github.com/adimail/quickflask/issues
Project-URL: Source, https://github.com/adimail/quickflask
Project-URL: Documentation, https://adimail.github.io/quickflask/
Keywords: flask,web development,cli tool
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: questionary
Requires-Dist: colorama
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# 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:

```sh
pip3 install quick-flask
```

```sh
pip3 install quick-flask --upgrade
```

## Usage

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

```sh
quickflask
```

![Usage](ss.jpeg)
![Usage](ss2.jpeg)

### Options:

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

Example:

```sh
quickflask --name my_flask_app
```

## Running Your Flask App

After creating your project, navigate into the directory:

```sh
cd my_flask_app
```

Set up a virtual environment (recommended):

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

Install dependencies:

```sh
pip install -r requirements.txt
```

Run the Flask app:

```sh
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](CHANGELOG.md) file.
