# 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
```
## Usage
Once installed, you can create a new Flask project by running:
```sh
quickflask
```
### Options:
- `--name` (Required): The name of your Flask application.
- `--socketio` (Optional): Include Flask-SocketIO support for real-time communication.
Example with SocketIO:
```sh
quickflask --name my-chat-app --socketio
```
## 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.
Latest version = 1.0.1
Raw data
{
"_id": null,
"home_page": "https://github.com/adimail/quickflask",
"name": "quick-flask",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "flask, web development, cli tool",
"author": "Aditya Godse",
"author_email": "adimail2404@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/94/7b/7168f513c1f600d71093c6585f2a1c1288c764146b1520ce7c8e2b6c6ce9/quick_flask-1.0.2.tar.gz",
"platform": null,
"description": "# QuickFlask\n\n**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\u2019t Repeat Yourself) principle.\n\n## Installation\n\nTo install QuickFlask, run:\n\n```sh\npip3 install quick-flask\n```\n\n## Usage\n\nOnce installed, you can create a new Flask project by running:\n\n```sh\nquickflask\n```\n\n### Options:\n\n- `--name` (Required): The name of your Flask application.\n- `--socketio` (Optional): Include Flask-SocketIO support for real-time communication.\n\nExample with SocketIO:\n\n```sh\nquickflask --name my-chat-app --socketio\n```\n\n## Running Your Flask App\n\nAfter creating your project, navigate into the directory:\n\n```sh\ncd my_flask_app\n```\n\nSet up a virtual environment (recommended):\n\n```sh\npython3 -m venv venv\nsource venv/bin/activate # On Windows: .\\venv\\Scripts\\activate\n```\n\nInstall dependencies:\n\n```sh\npip install -r requirements.txt\n```\n\nRun the Flask app:\n\n```sh\npython app.py\n```\n\nYour application will be accessible at `http://127.0.0.1:5000/`.\n\n## Features\n\n- Generates a structured Flask project with blueprints and templates.\n- Automatically sets up templates and API routes.\n- Saves time by eliminating repetitive boilerplate code.\n\n## Contributing\n\nFeel free to open issues or submit pull requests to improve QuickFlask. Contributions are always welcome!\n\n## License\n\nThis project is licensed under the MIT License. See `LICENSE` for details.\n\n## Change Log\n\nFor a detailed list of changes and version history, please see the [CHANGELOG.md](CHANGELOG.md) file.\n\nLatest version = 1.0.1\n",
"bugtrack_url": null,
"license": null,
"summary": "CLI tool to quickly generate Flask apps",
"version": "1.0.2",
"project_urls": {
"Bug Reports": "https://github.com/adimail/quickflask/issues",
"Documentation": "https://adimail.github.io/quickflask/",
"Homepage": "https://github.com/adimail/quickflask",
"Source": "https://github.com/adimail/quickflask"
},
"split_keywords": [
"flask",
" web development",
" cli tool"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a6f67ead33665b023e2a8f71607493c2cde54c597048c64f6ded2721d9346992",
"md5": "0f225322a8a05fb23a31a179bc725bda",
"sha256": "00f7a92c63fa213ff079d27f78535f6a3fbff1f6e25df4141a056433d76616c7"
},
"downloads": -1,
"filename": "quick_flask-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f225322a8a05fb23a31a179bc725bda",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8969,
"upload_time": "2025-01-31T18:17:56",
"upload_time_iso_8601": "2025-01-31T18:17:56.709140Z",
"url": "https://files.pythonhosted.org/packages/a6/f6/7ead33665b023e2a8f71607493c2cde54c597048c64f6ded2721d9346992/quick_flask-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "947b7168f513c1f600d71093c6585f2a1c1288c764146b1520ce7c8e2b6c6ce9",
"md5": "af13f07a38bdfa8c18a5c9ef57535073",
"sha256": "e3f2ecbf6f90b89db8f3b500977429e8e33569c4b9574dc01ff5619e5e230d30"
},
"downloads": -1,
"filename": "quick_flask-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "af13f07a38bdfa8c18a5c9ef57535073",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 14742,
"upload_time": "2025-01-31T18:18:00",
"upload_time_iso_8601": "2025-01-31T18:18:00.222086Z",
"url": "https://files.pythonhosted.org/packages/94/7b/7168f513c1f600d71093c6585f2a1c1288c764146b1520ce7c8e2b6c6ce9/quick_flask-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-31 18:18:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adimail",
"github_project": "quickflask",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "click",
"specs": []
}
],
"lcname": "quick-flask"
}
JSON
