Skip to content

Using Makefile commands

In order to use the Makefile commands you need to be on Linux.

Basic usage

Makefile commands are easy to use. Just type make in your terminal, hit enter and see the list of available commands.

make

The command above is equivalent to running:

make help

Development work commands

Git repo initialization

  • git-init - Initializes Git repository

    make git-init
    

Freezing project dependencies

  • lock-file - Creates conda-lock file

    make lock-file
    
  • release-lock-file - Creates conda-lock file without dev dependencies - to be used for deployment

    make release-lock-file
    

Creating environments

  • conda-lock-install - Creates env from conda-lock file

    make conda-lock-install
    
  • setup-pre-commit - Installs pre-commit hooks

    make setup-pre-commit
    
  • setup-editable - Installs the project in an editable mode

    make setup-editable
    
  • env - Creates local environment and installs pre-commit hooks

    make env
    
  • remove-env - Removes current conda environment

    make remove-env
    
  • recreate-env - Recreates conda environment by making new one from fresh lockfile

    make recreate-env
    

Project initialization

  • init-project - Runs git init, lock-file creation and env setup - to be used after cookiecutter initialization

    make init-project
    

Helper commands

  • format - Runs code formatting (ruff)

    make format
    
  • type-check - Runs type checking with mypy

    make type-check
    
  • test - Runs pytest

    make test
    
  • testcov - Runs tests and generates coverage reports

    make testcov
    
  • mpc - Runs manual pre-commit stuff

    make mpc
    
  • docs - Builds the documentation

    make docs
    
  • pc - Runs pre-commit hooks

    make pc
    
  • clean - Cleans artifacts

    make clean
    

Docker commands

  • docker-all - Docker default target - builds image and runs Docker container

    make docker-all
    
  • docker-build - Build Docker image

    make docker-build
    
  • docker-run - Run Docker container

    make docker-run
    
  • docker-stop - Stop Docker container

    make docker-stop
    
  • docker-rm - Remove Docker container

    make docker-rm
    
  • docker-rmi - Remove Docker image

    make docker-rmi
    
  • docker-clean - Clean up everything (container and image)

    make docker-clean
    
  • docker-rebuild - Rebuild and rerun Docker container

    make docker-rebuild