mardiportal-workflowtools

A collection of utility functions and helpers used when building workflows for the MaRDI Portal — for example, tools to update or interact with the MaRDI Knowledge Graph.

Installation

Clone the repository and install the package locally:

git clone https://github.com/MaRDI4NFDI/mardiportal-workflowtools.git
cd mardiportal-workflowtools
python -m pip install --upgrade pip setuptools
python -m pip install .

Create and activate a virtual environment

  python -m venv .venv
  source .venv/bin/activate  # On Windows use: .venv\\Scripts\\activate

With the environment active, install the package:

  python -m pip install --upgrade pip setuptools
  python -m pip install .

Secrets Configuration

Some tools require credentials (e.g., for authenticated API access). You can provide them in a simple key-value file named secrets.conf:

mardi-kg-user=your-username
mardi-kg-password=your-password

Make sure this file is kept outside version control (add it to .gitignore).

Example Usage

from mardiportal.workflowtools import some_utility_function