This is an example Flask project, using my preferred project structure and development environment setup. The instructions below are tailored for macOS.
This project implements the Flask tutorial from
the official documentation.
The application is called flaskr which is a simple blogging app. The
project is structured as a python package named flaskr.
Prerequisites: Follow one-time steps at https://github.com/jenkinz/python-project-template#one-time-steps-per-machine, then return here and run the commands below.
-
Run the following to create the Conda environment for this project:
$ conda env create -f environment.yaml -
Activate the environment by specifying the project name to
conda activate:$ conda activate <name> -
Verify the environment was activated correctly:
$ conda env list # should output all environments with a * next to the active env $ poetry --version # should output Poetry version X.Y.Z -
Install all Python dependencies:
$ poetry install -
Run the following commands to activate the required git pre-commit hooks:
$ pre-commit install -
Run the project test suite to verify everything is working:
$ pytest -
Initialize the local sqlite database:
$ export FLASK_APP=src/flaskr $ flask init-db -
Optional: Create a PyCharm run configuration:
- Select Flask Server as the type
- Enter
flaskras the name - Select Module and enter
flaskrin the Target field - Ensure
FLASK_ENVis set todevelopmentandFLASK_DEBUGis checked