A library for transforming an openAPI file to one or more dcat:DataService
Project description
oastodcat
A small Python library to transform an openAPI file to a dcat:DataService
At this moment we support all 3.0.x versions of (The OpenAPI specification)[https://github.com/OAI/OpenAPI-Specification]
Usage
Install
% pip install oastodcat
Getting started
import yaml
import requests
from datacatalogtordf import Catalog
from oastodcat import OASDataService
# Create catalog object
catalog = Catalog()
catalog.identifier = "http://example.com/catalogs/1"
catalog.title = {"en": "A dataset catalog"}
catalog.publisher = "https://example.com/publishers/1"
# Create a dataservice based on an openAPI-specification:
url = ("https://raw.githubusercontent.com/"
"OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml"
)
oas = yaml.safe_load(requests.get(url).text)
dataservice = OASDataService(oas)
dataservice.identifier = "http://example.com/dataservices/1"
dataservice.endpointDescription = url
#
# Add dataservice to catalog:
catalog.services.append(dataservice)
# Get dcat representation in turtle (default)
dcat = catalog.to_rdf()
print(dcat.decode())
Mapping
The following table shows how an openAPI specification is mapped to a dcat:DataService:
(Only dcat:DataService properties are shown.)
dcat:DataService | RDF property | openAPI v 3.0.x |
---|---|---|
endpoint description | dcat:endpointDescription | |
endpoint URL | dcat:endpointURL | servers.url |
serves dataset | n/a | |
access rights | ||
conforms to | dct:conformsTo | |
contact point | dcat:contactPoint | info.contact |
creator | ||
description | dct:description | info.description |
has policy | ||
identifier | n/a | |
is referenced by | ||
keyword/tag | ||
landing page | dcat:landingPage | externalDocs |
license | dct:license | info.license.url |
resource language | ||
relation | ||
rights | ||
qualified relation | ||
publisher | dct:publisher | |
release date | ||
theme/category | ||
title | dct:title | info.title |
type/genre | ||
update/modification date | ||
qualified attribution | ||
media type | dcat:mediaType | <it's complicated> |
Development
Requirements
Install
% git clone https://github.com/Informasjonsforvaltning/oastodcat.git
% cd oastodcat
% pyenv install 3.8.3
% pyenv install 3.7.7
% pyenv local 3.8.3 3.7.7
% 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()
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
oastodcat-2.0.0a3.tar.gz
(10.4 kB
view hashes)
Built Distribution
Close
Hashes for oastodcat-2.0.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e6549dced8643852c116ebb04c501f5421cff1b6927b6bc0848ea0d35062ecc |
|
MD5 | c45a75f3df41c104816c7a94dfb57642 |
|
BLAKE2b-256 | 41f90e8c6f992e677cde411e29425caf0bbce3696acd535760f5330a992dc46c |