Introduction

What is this about?

Installation

Without Docker

Install the python package of mardi-importer by first installing the requirements from requirements.txt,

pip install -r requirements.txt

Then install the packages via

pip install -U -e .

-U enforces reinstalling the package, with -e modifications in the source files are automatically taken into account.

Note: for convenience, local installations not using docker can be placed within virtual environments by first calling

python3 -m venv env
source env/bin/activate

With Docker

TODO

Build documentation

In docs/, run make html to generate the documentation for a local installation. The modules have to be installed and findable by import module. To view the docs, open the file docs/_build/html/index.html.

Usage

TODO