NOTICE: This is a Work In Progress Project. Merge requests are welcomed.

Flask Empty Compose

This is a simple boilerplate for rapid creating flask projects with docker-compose support.

The main idea behind this project is to make it easy to create a production grade project, with database, http server and web application that can be deployed to a swarm cloud with little hassle.

If you usually spends too much time configuring docker for new projects, flask-empty-compose is for you.

What do you get?

This template provides you with:

• docker-compose configuration
• configured nginx http server with letsencrypt
• configured flask-empty template
• optional: configured postgres database
• optional: configured mongodb
• optional: configured redis

Getting Started

# install if cookiecutter not installed
pip install cookiecutter  # might be called pip3 in your system

# install if fabric not installed
pip install fabric3  # might be called pip3 in your system

# create project from the template - linux/Mac
cookiecutter https://github.com/italomaia/flask-empty-compose

# call setup to create your web app with flask-empty
fab setup

# you're ready!

# check all available commands
fab --list

# available environments are: dev, tst, prd
fab env:dev up  # docker-compose up in development environment
fab env:tst up  # docker-compose up in testing environment
fab env:prd up  # docker-compose up in production environment

fab env:dev build  # docker-compose build in development environment
fab env:tst build  # docker-compose build in testing environment
fab env:prd build  # docker-compose build in production environment

fab env:dev on:<service_name> run:"<command>"  # docker-compose run in development environment
fab env:tst on:<service_name> run:"<command>"  # docker-compose run in testing environment
fab env:prd on:<service_name> run:"<command>"  # docker-compose run in production environment

fab env:dev logs:name  # docker logs on container called <name> in development environment
fab env:tst logs:name  # docker logs on container called <name> in testing environment
fab env:prd logs:name  # docker logs on container called <name> in production environment

Environments

By loading an environment, what you're actually doing is telling fabric which files to use to load you containers, that is, which docker-compose and envfile to load. Each has a minimal preset adequate to its name.

• dev use during development; it creates containers with development adequate configuration;
• tst or testing, creates containers with configuration very similiar to production and are adequate for testing;
• prd or production, creates containers that can run in production environment, that is, point to live data, do any necessary optimization and security checks needed;