Setup Python Project

This is my development setup for Python projects. It is constantly updated with new settings and tools.

Creating a project based on this strucutre

1. Clone this repository
2. Copy all the content (except .git folder)
3. Rename the project in .devcontainer/devcontainer.json

Running the application locally with Devcontainer (for VSCode users)

Prerequisites:

• Docker
• Docker-compose
• Install Remote - Containers extension in VSCode

This project is configured with a devcontainer. When openning the project in VSCode you will be asked to reopen it inside a devcontainer. Just wait the container to be ready (it may take some minutes in the first time) and your local environment will be ready with all dependencies and VSCode extensions installed.

Create an .env file:

cp .env_template .env

Main commands

Run the application

make

Run the tests

make test

Running the application locally (alternative for non-VSCode users)

Open terminal inside docker container

docker-compose run --rm app bash

Install dependencies

pipenv install --dev

You will be able to run the same commands to run the application.