Flinit ( flask init ) is a Python Command-Line Tool to Initialize a Python-Flask Project with Boilerplate Code and other required tools.
Flinit is a create-react-app like tool for Flask Projects.
- Creates Project Working Directory
- Spins up a Python Virtual Environment
- Generates Flask App File, app.py
- Installs Flask and CORS (optional)
- Adds Flask and CORS Helper Methods
- Adds Boilerplate Code to app.py
- Generates initial environment requirments file
- Adds README.md to the project
- Generates .gitignore for Python Project
- Initializes Git for Project.
Flinit can be used on any system with Python and PIP installed and PIP added to the OS Environment Path.
Flinit can be installed using Pip.
pip install flinit
After installing flinit using pip, goto any CLI and use the flinit command to setup the Flask App.
flinit [projectName] [location] -g -r -c
flinit [projectName] [location] -gt -rd -cr
flinit [projectName] [location] --git --readme --cors
projectName - The Name of the Project.
location - Path where Project is to be setup.
Flags
-h or --help - Provides Instruction about how to use Flinit.
-g or -gt or --git - Flag to add git to project. If this flag is used, git will be initialized for the project.
-r or -rd or --readme - Flag to add README.md to project. If this flag is used, a README file is generated.
-c or -cr or --cors - Flag to install and CORS to project. If this flag is used, CORS is installed and added a helper method is added to the app.py file.
Flinit Helper
Creating a Flask App webapp
Flask App webapp, initialized using flinit
