This project will create a generic, Dockerized, Flask application ready for action!

This example shows two different use-cases for the Flask Application. An API and an HTML site. If you want just an HTML site, you can remove the API functionality by deleting these lines in app/resources.py.

After following the setup instructions and starting your Docker container, you should have a running Flask application with two routes:

• An API description that displays here: https://localhost:3001/
• An API endpoint that displays the version here: https://localhost:3001/version
• A "Hello, World" HTML page here: https://localhost:3001/hello-world
• A Health Check page here: https://localhost:3001/healthcheck

Python

Flask

Docker Compose

git clone [email protected]:harvard-lts/docker-flask-template.git

After cloning your brand-new project repository, you can copy the files from this repository into it.

• Make a copy of the config example file ./env-example.txt
• Rename the file to .env
• Replace placeholder values as necessary

Note: The config file .env is specifically excluded in .gitignore and .dockerignore, since it contains credentials it should NOT ever be committed to any repository.

• Make a copy of the config example file ./webapp.conf.example
• Rename the file to webapp.conf
• Replace placeholder values as necessary (anything localhost will be changed in a deployed environment)

Note: The config file webapp.conf is specifically excluded in .gitignore and .dockerignore, since it can contain credentials it should NOT ever be committed to any repository.

• change container name on lines 8-9
• change network name on line 21
• change network name on lines 26-27

• change image name on lines 10-11

• change log file name on line 3
• change log file name on lines 14-15

• change title and description on lines 9-10

• change uid and gid on line 26

This command builds all images and runs all containers specified in the docker-compose-local.yml configuration.

docker-compose -f docker-compose-local.yml up --build --force-recreate

This step is only required if additional python packages must be installed during development. Update the requirements.txt inside the container to install new python packages.

Open a shell using the exec command to access the hgl-downloader container.

docker exec -it docker-flask-template bash

Once inside the mps-asset-validation container, run the pip install command to install a new package and update the requirements text file.

pip install packagename && pip freeze > requirements.txt

This command stops and removes all containers specified in the docker-compose-local.yml configuration. This command can be used in place of the 'stop' and 'rm' commands.

docker-compose -f docker-compose-local.yml down