https://github.com/romaindoyen/boilerplate-flask
A script to generate Flask projects.
https://github.com/romaindoyen/boilerplate-flask
flask pypi python-package
Last synced: 17 days ago
JSON representation
A script to generate Flask projects.
- Host: GitHub
- URL: https://github.com/romaindoyen/boilerplate-flask
- Owner: RomainDoyen
- License: mit
- Created: 2024-07-11T05:51:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T11:25:56.000Z (over 1 year ago)
- Last Synced: 2025-01-26T04:11:17.464Z (over 1 year ago)
- Topics: flask, pypi, python-package
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A script to generate Flask projects.
An installable Python package for generating Flask projects.
## Package folder structure
```bash
│ LICENSE
│ MANIFEST.in
│ README.md
│ setup.cfg
│ setup.py
│
└───flask_project_generator
generator.py
__init__.py
```
## Package files
- **`generator.py`** : Contains project creation logic.
- **`__init__.py`** : To mark the directory as a Python package.
- **`setup.py`** : Configuration file for `setuptools`.
- **`README.md`** : Package description.
- **`MANIFEST.in`** : Includes additional files in the package if required.
# Install dependencies
```bash
pip install Flask colorama
```
## Installation
Set-up instructions :
- Navigate to the root folder (flask_project_generator/).
- Install the package with the command :
```bash
pip install .
```
## Use
To generate a Flask project, run the following command:
```bash
generate-flask-project
```