servicecatalogtordf

A library that will map a service catalog (cpsv) to rdf

The library contains helper classes for the following cpsv and related classes:

• PublicService
• PublicOrganization
• LegalResource
• Rule
• Evidence
• Event

Usage

Install

% pip install servicecatalogtordf

Getting started

from datacatalogtordf import Catalog
from servicecatalogtordf import PublicOrganization, Service

# Create catalog object
catalog = Catalog()
catalog.identifier = "http://example.com/catalogs/1"
catalog.title = {"en": "A service catalog"}
catalog.publisher = "https://example.com/publishers/1"

# Create a service:
service = Service("http://example.com/services/1")
service.title = {"nb": "inntektsAPI", "en": "incomeAPI"}
# Create a public organization:
public_organization = PublicOrganization("https://example.com/publishers/1")
# Add it to the service:
service.has_competent_authority = public_organization
#
# Add service to catalog:
catalog.contains_services.append(service)

# Get rdf representation in turtle (default)
rdf = catalog.to_rdf()
print(rdf)

Development

Requirements

• pyenv (recommended)
• pipx (recommended)
• poetry
• nox
• nox-poetry

% pipx install poetry==1.1.7
% pipx install nox==2021.06.12
% pipx inject nox nox-poetry

Install locally

% git clone https://github.com/Informasjonsforvaltning/servicecatalogtordf.git
% cd servicecatalogtordf
% pyenv install 3.8.12
% pyenv install 3.9.10
% pyenv local 3.8.12 3.9.10
% poetry install

Run all sessions

% nox

Run all tests with coverage reporting

% nox -rs tests

Debugging

You can enter into Pdb by passing --pdb to pytest:

nox -rs tests -- --pdb

You can set breakpoints directly in code by using the function breakpoint().