Skip to content

Command Line Interface for common Flask operations

License

Notifications You must be signed in to change notification settings

kjbrawner22/Flaskify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flaskify

Command Line Interface for common Flask operations

  1. Installation
    • Prerequisites: have python3, pip3, and venv installed. Then run the next commands.
    • git clone https://github.com/kjbrawner22/Flaskify.git
    • cd Flaskify
    • pip3 install -e . (e flag signals development mode).
      • Note: after every change to the source code, you should run this command again.
      • Note: I have not tried this with python2. Please let me know if it works or if it needs some changes.

    ---OR---

    • Simply Run pip3 install flaskify to install from PyPI.
  2. Usage:
    • flaskify new
      • This generates a project structure for an easily-scalable Flask app.
      • prompts you for the project name.
      • All other commands should be run under the root directory created by this command.
    • flaskify run
      • combines the export FLASK_APP=run.py and flask run into 1 step.
  3. Contribution
    • Always Welcome! If you can make this tool better, fix my code, add documentation, or have ideas for new features, please submit a pull request.
  4. Plans for the Future
    • Set up a config system to allow for custom naming and tracking of project-generated files.
    • Add more generation options such as Forms, Mail setup, etc.

Thanks for using/contributing to Flaskify :)

About

Command Line Interface for common Flask operations

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages