GOB-Export

GOB Export contains the logic to export GOB data in various formats.

The primary goal of this component is to preserve the existing DIVA products. This will allow for a migration to GOB that minimizes the impact for the existing users of DIVA output.

Infrastructure

A running GOB infrastructure and GOB API is required to run this component.

Secure data

In order to access secure data over the GOB API you need to define environment variables:

• OIDC_TOKEN_ENDPOINT
• OIDC_CLIENT_ID_GOB
• OIDC_CLIENT_SECRET_GOB

Docker

Requirements

• docker compose >= 1.25
• Docker CE >= 18.09

Run

docker compose build
docker compose up &

Tests

docker compose -f src/.jenkins/test/docker-compose.yml build
docker compose -f src/.jenkins/test/docker-compose.yml run --rm test

Local

Requirements

• Python >= 3.9

Initialisation

Create a virtual environment:

python3 -m venv venv
source venv/bin/activate
pip install -r src/requirements.txt

Or activate the previously created virtual environment:

source venv/bin/activate

Run

Optional: Set environment if GOB-Export should connect to Objectstore:

export $(cat .env | xargs)  # Copy from .env.example if missing

Start the service:

cd src
python -m gobexport

Tests

Run the tests:

cd src
sh test.sh

Remarks

Trigger exports

Exports are triggered by the GOB-Workflow module. See the GOB-Workflow README for more details.

Configuration

The exports are highly data driven. The configurations are stored in gobexport/exporter/config/.

Objectstore exports

The output files are placed on the configured objectstore under {CONTAINER_BASE}/{catalog}/{file}. The CONTAINER_BASE default value is distributie.

It is recommended to change this value in development to development in the .env file.