Getting Started
What is this about?
Installation
Without Docker
The project uses a src/ layout, so it has to be installed before
anything is importable. Dependencies are declared in pyproject.toml and
are resolved by pip:
pip install -U -e .
This installs both the mardi_importer and mardi_portal
packages. -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.
Version
The release version is derived from the git tag by setuptools-scm; there is no
checked-in VERSION file. It is available via:
CLI:
mardi-importer --versionFlask:
GET /version