Ontolutils - Object-oriented "Things"

Tests Status pyvers Status

This package helps you in generating ontology-related objects and lets you easily create JSON-LD files.

Quickstart

Installation

Install the package:

pip install ontolutils

Usage

Imagine you want to describe a prov:Person with a first name, last name and an email address but writing the JSON-LD file yourself is too cumbersome and you want validation of the parsed parameters. The package lets you design classes, which describe ontology classes like this:

import rdflib
from pydantic import EmailStr, Field
from pydantic import HttpUrl, model_validator

from ontolutils import Thing, urirefs, namespaces, as_id


@namespaces(prov="https://www.w3.org/ns/prov#",
            foaf="https://xmlns.com/foaf/0.1/",
            m4i='http://w3id.org/nfdi4ing/metadata4ing#')
@urirefs(Person='prov:Person',
         firstName='foaf:firstName',
         lastName='foaf:lastName',
         mbox='foaf:mbox',
         orcidId='m4i:orcidId')
class Person(Thing):
    firstName: str
    lastName: str = Field(default=None, alias="last_name")  # you may provide an alias
    mbox: EmailStr = Field(default=None, alias="email")
    orcidId: HttpUrl = Field(default=None, alias="orcid_id")

    # the following will ensure, that if orcidId is set, it will be used as the id
    @model_validator(mode="before")
    def _change_id(self):
        return as_id(self, "orcidId")


p = Person(
    id="https://orcid.org/0000-0001-8729-0482",
    label=rdflib.Literal("The creator of this package", lang="en"),
    firstName='Matthias',
    last_name='Probst'
)
# as we have set an alias, we can also use "lastName":
p = Person(
    id="https://orcid.org/0000-0001-8729-0482",
    label=rdflib.Literal("The creator of this package", lang="en"),
    firstName='Matthias',
    lastName='Probst'
)
# The jsonld representation of the object will be the same in both cases:
json_ld_serialization = p.model_dump_jsonld()
# Alternatively use
serialized_str = p.serialize(format="json-ld")  # or "ttl", "n3", "nt", "xml"

The result of the serialization is shown below:

{
  "@context": {
    "owl": "http://www.w3.org/2002/07/owl#",
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "schema": "http://schema.org/",
    "prov": "https://www.w3.org/ns/prov#",
    "foaf": "https://xmlns.com/foaf/0.1/",
    "m4i": "http://w3id.org/nfdi4ing/metadata4ing#"
  },
  "@id": "https://orcid.org/0000-0001-8729-0482",
  "@type": "prov:Person",
  "foaf:firstName": "Matthias",
  "foaf:lastName": "Probst"
}

Define an ontology class dynamically:

If you cannot define the class statically as above, you can also define it dynamically:

from typing import List, Union

from ontolutils import build, Property, Thing

Event = build(
    namespace="https://schema.org/",
    namespace_prefix="schema",
    class_name="Event",
    properties=[Property(
        name="about",
        default=None,
        property_type=Union[Thing, List[Thing]]
    )]
)
conference = Event(label="my conference", about=[Thing(label='The thing it is about')])
ttl = conference.serialize(format="ttl")

The serialization in turtle format looks like this:

@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix schema: <https://schema.org/> .

[] a schema:Event ;
    rdfs:label "my conference" ;
    schema:about [ a owl:Thing ;
            rdfs:label "The thing it is about" ] .

Add a property at runtime

Say, we forgot to add the location to the above Event class. No problem, we can add it at runtime:

Event.add_property(
    name="location",
    property_type=Union[Thing, List[Thing]],
    default=None,
    namespace="https://schema.org/",
    namespace_prefix="schema"
)
conference = Event(
    label="my conference",
    location=Thing(label="The location")
)
ttl = conference.serialize(format="ttl")

The above fives us this Turtle serialization:

@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix schema: <https://schema.org/> .

[] a schema:Event ;
    rdfs:label "my conference" ;
    schema:location [ a owl:Thing ;
            rdfs:label "The location" ] .

Documentation

Please visit the documentation for more information.

Metadata

Release files for ontolutils 0.27.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ontolutils 0.27.7
File	Size	Uploaded
ontolutils-0.27.7.tar.gz	180.9 kB	Feb 3, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ontolutils 0.27.7
File	Interpreter	ABI	Platform	Reset
ontolutils-0.27.7-py3-none-any.whl 177.2 kB Feb 3, 2026	Python 3	none	any	Details

Total release size: 358.1 kB

Release files / ontolutils-0.27.7.tar.gz

Download URL	ontolutils-0.27.7.tar.gz
Size	180.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`0046e5c427e3946e624eaf8e4c8367dd060f5b81dcc73534c450a83ec9c61202`
BLAKE2b-256 checksum How to use checksums	`0562304add026cd9ea76d4ea8493fa1ee4685d4367a28b6c613d5dd4724d1916`
Upload date	Feb 3, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.0.1 CPython/3.12.12`

Release files / ontolutils-0.27.7-py3-none-any.whl

Download URL	ontolutils-0.27.7-py3-none-any.whl
Size	177.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`86cf2d2736e3aec50f59d8c5a1918a5f782d8121f9a311e6413b522418929987`
BLAKE2b-256 checksum How to use checksums	`0d4dd12f081c1f3109fe78621a9886e55d3f8f8e45b2e5e31d5aefac4a50dbbe`
Upload date	Feb 3, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.0.1 CPython/3.12.12`