Skip to main content

A library of algorithms for working with JSON-LD and translating between various forms of RDF.

Project description

TRLD

TRLD is a transpilable implementation of algorithms for working with Linked Data as JSON-LD. This includes translating to and from various RDF syntaxes and mapping of vocabularies.

Transpiling Linked Data Algorithms

TRLD is written in typed Python, with some extra care taken to support transpilation. The implementation can currently be transpiled into:

  • Java
  • Javascript

The transpiler is part of the codebase and only supports the small (somewhat redundantly cast) subset of type-annotated Python needed to implement these algorithms. It is not a generic transpiler.

Transcribing Linked Data

When parsing RDF, the syntactic statements are transcribed verbatim into JSON-LD, keeping compact forms and ordering as much as possible. Conversely, serialization is done by writing the JSON-LD shape out as is, using the chosen syntax.

In order to control the exact shape of this data, use the JSON-LD algorithms for expansion, flattening and compaction.

Serializing JSON-LD as Turtle or TriG

At this time, care must be taken to use simple JSON-LD contexts in order for Turtle or TriG serialization to work. That means that, apart from prefixes and some support for language indexes and type coercion, no advanced compaction features of JSON-LD 1.1 will work when transcribing the data out as Turtle or TriG. If you process such compacted data, ensure to expand it first, and preferably re-compact it into a simpler form.

Implemented Algorithms

JSON-LD 1.1 (W3C Spec)

  • Expansion
  • Compaction
  • Flattening
  • RDF Serialization/Deserialization

N-Quads (W3C Spec)

  • Parser
  • Serializer

TriG (W3C Spec)

  • Parser
  • Serializer

RDF Dataset Canonicalization (W3C Spec)

  • Canonicalization
  • Canonical n-quads form

Target Vocabulary Maps (Experimental)

  • Basic RDFS & OWL
  • Property chains
  • Reified forms
  • SKOS matches

Running

Python-based command-line usage:

$ python3 -m trld [-h] [-c CONTEXT] [-e [EXPAND_CONTEXT]] [-b BASE] [-f] \
  [-i INPUT_FORMAT] [-o OUTPUT_FORMAT] [SOURCE ...]

Java-based command-line usage:

$ java -jar build/java/build/libs/trld-with-deps.jar [-f] [-c CONTEXT] FILE

JS-based command-line usage:

$ cd build/js
$ node -r esm lib/jsonld/cli.js [-f] [-c CONTEXT] FILE

Building, Testing and Status

Build requirements:

  • Make
  • For Python: Python >=3.10,<3.14 (plus mypy and pytest for development, and hatchling for packaging)
  • For Java: Java 11+ (uses Gradle Wrapper)
  • For JS: Node 20+ (using ES6 & ESM)

Note: TRLD runs well on Python 3.14, but the transpiler does not (yet).

(A pixi.toml file is available for declarative development environments using Pixi.)

For Python, this runs mypy, pytest and the test suite:

$ make pytest
[...]

Running test suite: cache/json-ld-api/tests/expand-manifest.jsonld
Ran 376 test cases. Passed: 372. Failed: 3. Errors: 1.
Running test suite: cache/json-ld-api/tests/compact-manifest.jsonld
Ran 244 test cases. Passed: 241. Failed: 2. Errors: 1.
Running test suite: cache/json-ld-api/tests/flatten-manifest.jsonld
Ran 55 test cases. Passed: 55. Failed: 0. Errors: 0.
Running test suite: cache/json-ld-api/tests/fromRdf-manifest.jsonld
Ran 52 test cases. Passed: 52. Failed: 0. Errors: 0.
Running test suite: cache/json-ld-api/tests/toRdf-manifest.jsonld
Ran 456 test cases. Passed: 405. Failed: 50. Errors: 1.
python3 -m trld.tvm.test
Running [...]: OK

python3 -m trld.trig.test | grep '^Ran '
Ran 335 tests. Passed 303, failed 32

python3 -m trld.trig.test_serializer | grep '^Examined '
Examined 335 tests. Round-tripped 232, passed 223, failed 6

For the other languages, this will generate packages for each language in the build directory, then run their respective test suites:

$ make java
[...]
java -cp build/java/build/libs/trld-with-deps.jar trld.jsonld.TestRunner [...]
Ran 371 test cases. Passed: 330. Failed: 14. Errors: 27.

java -cp build/java/build/libs/trld-with-deps.jar trld.trig.Test [...]
Ran 335 tests. Passed 252, failed 83

$ make js
[...]
1..551
# tests 551
# pass  540
# fail  11

[...] node [...] lib/trig/test.js [...]
Ran 335 tests. Passed 270, failed 65

To generate transpiled source code without source line comments, use:

$ make TRFLAGS=-L javatr

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trld-0.3.0.tar.gz (68.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

trld-0.3.0-py3-none-any.whl (84.3 kB view details)

Uploaded Python 3

File details

Details for the file trld-0.3.0.tar.gz.

File metadata

  • Download URL: trld-0.3.0.tar.gz
  • Upload date:
  • Size: 68.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for trld-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1ad1aafa64b4f5127af5b7a06b32e268d804051ae8790e7fda2a6ea81e1f3854
MD5 e5dda1a482284dd77c044d5b837a5eca
BLAKE2b-256 74e1d3e2c6816ab0b9fe32630ce0ce70dc62b0eaa1ff87717743981df296b75d

See more details on using hashes here.

Provenance

The following attestation bundles were made for trld-0.3.0.tar.gz:

Publisher: publish-to-pypi.yml on niklasl/trld

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file trld-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: trld-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 84.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for trld-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5be95628f6886b82e4fc63729f4e97b6ddafc53ad30becaf6cea9cd8cd35dd1c
MD5 98af9f9831ffec12448f7352fcbde9f6
BLAKE2b-256 98086863f32cabb311dec1067c4c29a717b74c5919724fbafeee528112a65e40

See more details on using hashes here.

Provenance

The following attestation bundles were made for trld-0.3.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on niklasl/trld

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page