DO NOT FORK, CLICK "Use this template" - A github template to start a Flask Project - this uses github actions to generate your project based on the template.
A full feature Flask project template.
See also
DO NOT FORK this is meant to be used from Use this template feature.
my_awesome_project
recommendation is to use all lowercase and underscores separation for repo names.)settings->secrets
add your PIPY_API_TOKEN
and CODECOV_TOKEN
(get the tokens on respective websites)NOTE: WAIT until first CI run on github actions before cloning your new project.
make switch-to-poetry
later if you want.Containerfile
is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.python -m <project_name>
or $ project_name
with basic CLI argument parsing.Curious about architectural decisions on this template? read ABOUT_THIS_TEMPLATE.md
If you want to contribute to this template please open an issue or fork and send a PULL REQUEST.
project_description
From source:
git clone https://github.com/author_name/project_urlname project_name
cd project_name
make install
From pypi:
pip install project_name
This application has a CLI interface that extends the Flask CLI.
Just run:
$ project_name
or
$ python -m project_name
To see the help message and usage instructions.
project_name create-db # run once
project_name populate-db # run once (optional)
project_name add-user -u admin -p 1234 # ads a user
project_name run
Go to:
Note: You can also use
flask run
to run the application.