README.md

python-template

Generic python project template to get you started utilizing docker containers.

Predefined containers include:

• Python
• MongoDB
• PostgreSQL
• RabbitMQ
• MySQL
• phpMyAdmin

Quickstart

make

This installs any dependencies and fires up all containers

Tests

Running tests

make test

Discovers any testfile matching test*.py

Tests with coverage reports

make coverage

HTML coverage report will be dumped to ./htmlcov

Remember to use coverage before committing so the build will not fail after pushing!

Linting

Running the linter

make lint

Installing the linter as pre commit hook

make install_pre_commit

Starting an interactive python console

make shell

Running custom commands in the python container

docker-compose run --rm py <your command>

Hints

Exporting all files

For example if you want to use this template to start working in an other repository.

git archive master | tar -x -C /somewhere/else