Metadata-Version: 2.1
Name: flask-setup
Version: 0.3.0
Summary: A simple tool to help you setup a flask project for web development, API development and just any basic app
Home-page: https://github.com/mrteey/flask-setup
Author: Nasir Mustapha
Author-email: nasir@mrteey.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# flask-setup #
Flask Setup Tool

# INSTALLATION #
`$ pip install flask-setup`

# USAGE #

1. create a virtual environment and activate it:
   `$ python -m venv venv`
   `$ source venv/bin/activate`
   `$ flask_setup --flag argument`

# FLAGS #

1. --init or -i: Intialize Flask-Setup in project folder; this makes sure you dont need to pass
   project name each time you call flask_setup
    `$ flask_setup --init project_name` OR `$ flask_setup -i project_name`

2. --build or -b: Takes flask app type to build; currently support ['api', 'standard', 'basic']
    `$ flask_setup --build api` OR `$ flask_setup -b api`

3. --generate or -g: Takes generator type; currently supports ['model', 'marshmallow', 'blueprint'] e.g.
    `$ flask_setup --generate blueprint -blueprint api` this will generate a blueprint with the name 'api'
    OR 
    `$ flask_setup --generate model`

4.  --destroy or -d: pass this alongside a generator ['marshmallow', 'blueprint', 'model'] e.g.:
    `$ flask_setup -d blueprint -blueprint myblueprintname`
    OR 
    `$ flask_setup -d model`
5.  --install or -install: pass this alongside a module e.g.:
    `$ flask_setup -install flask` this will install flask and freeze to requirements file
6.  --uninstall or -uninstall: pass this alongside a module e.g.:
    `$ flask_setup -uninstall flask` this will uninstall flask and freeze to requirements file

