Metadata-Version: 2.1
Name: flask-setup
Version: 0.5.5
Summary: A simple tool to help you setup a flask project quickly
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
Requires-Dist: typer

# flask-setup #
Flask Setup Tool

# INSTALLATION #
`$ pip install flask-setup`

# USAGE #

1. run an fs command:
   `$ fs command argument`

# COMMANDS #

1. build: Build a project with given name.
    `$ fs build projectname`

2. add: Takes blueprint name e.g.
    `$ fs add api` this will add a blueprint with the name 'api'

3. remove: Takes blueprint name e.g.
    `$ fs remove api` this will remove the blueprint with the name 'api'

4. copy: Takes blueprint name e.g.
    `$ fs copy bp_to_copy bp_to_paste` this will copy the blueprint with the name 'bp_to_copy' to 'bp_to_paste'

5.  install: pass this alongside a module e.g.:
    `$ fs install flask` this will install flask and freeze to requirements file

6.  uninstall: pass this alongside a module e.g.:
    `$ fs uninstall flask` this will uninstall flask and freeze to requirements file

7.  destroy: This will destroy the current project e.g.:
    `$ fs destroy`

8.  init: Initializes fs on an existing project with similar setup e.g.:
    `$ fs init` this will create a .fs file in the root directory of the project

9. start: Starts the server e.g.:
    `$ fs start` this will start the server


