A flask app generator package
Project description
Build Flask App
An easy to use flask app generator that allows users to create flask apps simply by running one command. You can check out the official website here.
Install using source code
To download the app generator, you can clone this repository to your local machine.
$ git clone https://github.com/kouul/build-flask-app
$ cd build-flask-app
Install using pip3
$ pip3 install build-flask-app
Package @ PyPI repository: https://pypi.org/project/build-flask-app/
Usage
Ensure that you have flask installed on your environment. You can install flask using pip3 install flask.
$ build-flask-app app_name
$ cd app_name
$ python3 app.py
Open up http://localhost:5000/ to see your Hello World app.
Arguments
Args | Usage | Definition |
---|---|---|
-d | $ python3 build-flask-app.py app_name -d | debugger mode on |
-sl3 | $ python3 build-flask-app.py app_name -sl3 | sqlite3 mode on |
-cj | $ python3 build-flask-app.py app_name -cj | import style.css and app.js |
-bs | $ python3 build-flask-app.py app_name -bs | import bootstrap cdn |
-jq | $ python3 build-flask-app.py app_name -jq | import jQuery cdn |
-gsap | $ python3 build-flask-app.py app_name -gsap | import GSAP cdn |
-fa | $ python3 build-flask-app.py app_name -fa | import Font Awesome cdn |
-dc | $ python3 build-flask-app.py app_name -dc | containerize app in docker |
Below is a list of arguments you can pass when building your flask application.
Enable Debug Mode
You can enable debug mode on while creating your flask app by using the option -d or --debugger
$ python3 build-flask-app.py app_name -d
Enable SQLite3 Mode
You can set sqlite3 configuration while creating your flask app by using the option -sl3 or --sqlite3
$ python3 build-flask-app.py app_name -sl3
Import style.css and app.js
You can import stylesheet and javascript file automatically while creating the app using -cj or --css-js option
$ python3 build-flask-app.py app_name -cj
Import bootstrap CDN
You can import bootstrap automatically via the CDN using -bs or --bootstrap option
$ python3 build-flask-app.py app_name -bs
Import jQuery CDN
You can import jQuery automatically via the CDN using -jq or --jquery option
$ python3 build-flask-app.py app_name -jq
Import Gsap CDN
You can import Gsap automatically via the CDN using -gsap or --gsap option
$ python3 build-flask-app.py app_name -gsap
Import Font Awesome CDN
You can import Font Awesome automatically via the CDN using -fa or --font-awesome option
$ python3 build-flask-app.py app_name -fa
Create Dockerfile and docker-compose script
You can push the app to a docker container instead of running it locally. Simply use -dc or --docker-container option. Please note that the image generated in Dockerfile is python:3.7-alpine. You might want to change this to the non-alpine version for big projects
$ python3 build-flask-app.py app_name -dC
Features
- Manual(--help)
- Debug option on (-d)
- SQLite3 option on (-sl3)
- Include Stylesheet and Script (-cj)
- Push app to docker container (-dc)
- Import bootstrap css library (-bs)
- Import jQuery library (-jq)
- Import gsap js library (-gsap)
- Import font awesome library (-fa)
- Import zurb foundations library (-zb)
- Import angular js library (-an)
- Deploy on heroku (-hK)
Feel free to create issue in case something is not working :)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for buildflaskapp-0.2.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20e26d983bac0bd42f81f6fc73d058ebd952d6a36c188596b22ac9002491195b |
|
MD5 | 8f2126ac724516f1b35b7ffc8cca7c41 |
|
BLAKE2b-256 | fe87943f8d83352eb4ca7f9ae2d1408dbd0e4d20397325be60a9d76a4eac1cf1 |