Setup

Installation

The source code of the project can be found in its GitHub repository. The required dependencies and the package itself can be installed using pip:

pip install -r requirements.txt
pip install -e .

Configuration

Configuration parameters can be provided in a JSON file. The config file contains information about the database(s) that bdat interacts with. It is currently only necessary for using the Kadi4Mat integration. Bdat will try to read the configuration from the following locations, from top to bottom:

• The path that is passed using the -c / –config option, if it is specified.

• ./config.json

• ~/.config/bdat/config.json

An example config file looks like this:

{
    "databases": {
        "kadi": {
            "type": "kadi",
            "url": "https://example.org",
            "token": "pat_xxxxxxxxxxxxx"
        }
    }
}