Python Boilerplate 🐍

Technologies

Python
Flask
SQLAlchemy
PostgresSQL
Docker

Required Dependencies

pip3 sudo apt-get -y install python3-pip
virtualenv pip3 install virtualenv
pre-commit pip3 install pre-commit

Base Setup

Install setup . install.sh

Installation of the necessary “packages”.

Docker → Docker Installation Tutorial
Docker compose → docker-compose Installation Tutorial

Environment variables

You need create .env file, use .env.example file for template

APPLICATION_PORT=3008

DATABASE_HOST=localhost
DATABASE_PORT=5432

POSTGRES_USER=postgres_user
POSTGRES_PASSWORD=postgres_password
POSTGRES_DB=postgres_database

Start Project

Docker is configured to raise two containers, the flask application image and the postgres database. For more details see the docker-compose.yml configuration file

docker-compose up --build

If everything went well, you will be able to access the web api on localhost and the port chosen in your .env by default: http://127.0.0.1:3008/