Generic Python template project

Structure

• bin/
  scripts for running project in Docker-based infrastructure

• envs/
  contains variables for specific environments

• requirements/
  contains text files with dependencies

• requirements.txt
  main file for describing dependencies for PROD environment

• .dockerignore
  File contains rules what should not be copied into Docker image

• .editorconfig
  Editorconfig describes default text encoding, line endings and indent for specific file formats

• .gitignore
  use Gitignore.io for generation this file. Pls see following config as example

• .pre-commit-config.yaml
  Git hooks implemented via Pre-commit

• Dockerfile
  Building docker image for simplifying deployment acc. to best practices

• Makefile
  Makefile used for automation some routines, i.e. create virtual environment, install dependencies and so on.

• readme.md
  This readme. Used Markdown syntax

• requirements.txt
  Python PIP dependencies for PROD env

• requirements-dev.txt
  Python PIP dependencies for DEV env

• TBD build wheel

Init Dev environment via virtualenv

virtualenv -p `which python3` venv
source venv/bin/activate

Configure Git hooks

pre-commit install