Makefile.md

Makefile 🔨

This is the description how to use the Makefile with the make command.

👉 You can delete this file before committing your project to GitHub.

Description ✏️

If you are a bit lazy like me and don't want to type the same commands into the shell all the time, using make is a relief.

You can use the Makefile to setup your local development environment, to build and run the Docker container locally and to clean up your local environment.

You need to have make installed on your system. If you want to use the Docker commands, you need to have Docker installed on your system. The Makefile should work on Linux, MacOS and Windows.

For the details of the commands have a look at the Makefile itself.

Prerequisites ✔️

• You have installed make on your system.
• If you want to use the docker commands, you have installed Docker on your system.

Makefile commands 💻

Below you find a list of the commands you can use with the Makefile.

Commands to setup the python virtual environment 🐍

make update  # update local python packages related to package and virtualenv management

make venv  # create the python virtual environment

make venvupdate  # update the python virtual environment

make all  # make these 3 steps in one go: cleanpy, update, venv

Docker related commands 🐳

make docker  # build the docker image and tag it as (folder name):latest

Cleanup commands 🗑️

make cleanpy  # delete all local python __cache__ files

make cleanvenv  # delete the whole python virtual environment

make cleanall  # delete the whole python virtual environment and all __cache__ files