pyrudof - Python bindings for Rudof

pyrudof provides Python bindings for rudof, a Rust library for Semantic Web operations.

At a high level it supports:

Loading and serializing RDF and PG data.
Loading, checking, serializing and validating ShEx schemas.
Loading, serializing and validating SHACL shapes.
Loading, serializing and validating PGSchemas.
Loading, running and serializing SPARQL queries and query results.
Converting and comparing schemas between supported formats.
Loading and serializing DCTAP and Service Descriptions.
Generating synthetic data from schemas.

Installation

Install from PyPI (recommended)

pip install pyrudof

pyrudof is built with PyO3 using abi3 wheels (Python 3.7+ compatible).

Build from source

Building from source requires a working Rust toolchain and Python.

# Clone the repository
git clone https://github.com/rudof-project/rudof.git
cd rudof/python

# Optional but recommended: virtual environment
python -m venv .venv
# Linux/macOS:
source .venv/bin/activate
# Windows PowerShell:
# .\.venv\Scripts\Activate.ps1

# Build and install editable package
pip install maturin
pip install -e .

For a release wheel:

maturin build --release
pip install --force-reinstall target/wheels/pyrudof-*.whl

Architecture and package structure

Package layout

Path	Purpose
`src/`	Rust implementation of the Python bindings (`Rudof`, `RudofConfig`, generator APIs, enums, and error mappings).
`stubs/pyrudof/`	Hand-maintained `.pyi` type stubs for static type checking and editor support.
`examples/`	Runnable example scripts organized by category, plus `examples.toml` manifest metadata.
`tests/`	Python `unittest` suite and manifest registry loader for example-based tests.
`docs/`	Sphinx docs, including the examples page generator (`generate_examples_doc.py`).
`Cargo.toml` / `pyproject.toml`	Rust crate and Python build configuration (`maturin` + PyO3).

Test architecture

Tests are dynamically generated from examples/examples.toml.

Each generated test:

Executes the registered Python example as a subprocess.
Asserts a zero exit code.
Checks configured expected_output substrings (if any).

Component	Purpose
`tests/test_examples.py`	Builds dynamic `unittest.TestCase` classes per category/example.
`tests/examples_registry.py`	Loads and validates `examples/examples.toml` entries.
`examples/examples.toml`	Single source of truth for metadata and category order.
`examples/*/.py`	Executable example scripts run by tests and referenced by docs.

Testing

All test commands are run from bindings/python/tests.

Run the full suite

cd bindings/python/tests
python -m unittest discover -vvv

Run a specific category or test

# All ShEx examples
python -m unittest test_examples.TestShexExamples -v

# All SHACL examples
python -m unittest test_examples.TestShaclExamples -v

# All data generation examples
python -m unittest test_examples.TestGenerateExamples -v

# A single example
python -m unittest test_examples.TestShexExamples.test_shex_validate_inline -v

Run skipped examples

Examples marked with skip_test = true in the manifest are skipped by default.

# Linux/macOS
RUN_SKIPPED_EXAMPLES=1 python -m unittest test_examples -v

# Windows PowerShell
$env:RUN_SKIPPED_EXAMPLES="1"; python -m unittest test_examples -v

Examples and documentation

The examples system is intentionally centralized:

examples/examples.toml stores metadata (key, source_file, title, description, category, files, expected_output, skip_test).
examples/**/*.py stores the executable code.
tests/test_examples.py and docs/generate_examples_doc.py both read from that same manifest.

Available categories

Category	Description
`rdf`	RDF loading, serialization, node inspection
`sparql`	SELECT / CONSTRUCT query workflows
`shex`	ShEx loading, validation, and serialization
`shacl`	SHACL loading, validation, extraction, serialization
`dctap`	DCTAP profile handling
`endpoint`	Service description examples
`generate`	Synthetic data generation APIs
`utility`	Config, resets, version, module/error helpers

Add a new example

Create a runnable script under bindings/python/examples/ (recommended: place it inside a category subfolder, for example bindings/python/examples/shex/my_example.py).
Register it in bindings/python/examples/examples.toml.
Run tests from bindings/python/tests.
Regenerate and check docs in bindings/python/docs.

Manifest template:

[[example]]
key = "my_example"
source_file = "shex/my_example.py"
title = "My Example"
description = "What this example demonstrates"
category = "shex"  # rdf | sparql | shex | shacl | dctap | endpoint | generate | utility
files = { data = "person.ttl" }  # optional referenced files
expected_output = ["Alice"]       # optional substrings (can be empty list)
# skip_test = true                 # optional (network/special runtime)

Build docs locally

cd bindings/python/docs
python generate_examples_doc.py --update
python generate_examples_doc.py --check
python -m sphinx -b html . _build/html

Then open bindings/python/docs/_build/html/index.html.

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

pyrudof-0.3.12-cp37-abi3-win_amd64.whl (10.1 MB view details)

Uploaded Aug 26, 2026 CPython 3.7+Windows x86-64

pyrudof-0.3.12-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.5 MB view details)

Uploaded Aug 26, 2026 CPython 3.7+manylinux: glibc 2.17+ x86-64

pyrudof-0.3.12-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (11.5 MB view details)

Uploaded Aug 26, 2026 CPython 3.7+manylinux: glibc 2.17+ ARM64

pyrudof-0.3.12-cp37-abi3-macosx_11_0_arm64.whl (10.3 MB view details)

Uploaded Aug 26, 2026 CPython 3.7+macOS 11.0+ ARM64

pyrudof-0.3.12-cp37-abi3-macosx_10_12_x86_64.whl (10.7 MB view details)

Uploaded Aug 26, 2026 CPython 3.7+macOS 10.12+ x86-64

File details

Details for the file pyrudof-0.3.12-cp37-abi3-win_amd64.whl.

File metadata

Download URL: pyrudof-0.3.12-cp37-abi3-win_amd64.whl
Upload date: Aug 26, 2026
Size: 10.1 MB
Tags: CPython 3.7+, Windows x86-64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.15.0

File hashes

Hashes for pyrudof-0.3.12-cp37-abi3-win_amd64.whl
Algorithm	Hash digest
SHA256	`41823a2bf032c8c38301f1f3dbe567471d662d5234a0b6dc2d3accc587950725`
MD5	`7a0b4e6c795686ded358b0c5ea17169b`
BLAKE2b-256	`4f1cd1eb4e98f956389753f4eba4551cb22da95598cbd17516a6ada19c075e1f`

See more details on using hashes here.

File details

Details for the file pyrudof-0.3.12-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

Download URL: pyrudof-0.3.12-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Upload date: Aug 26, 2026
Size: 11.5 MB
Tags: CPython 3.7+, manylinux: glibc 2.17+ x86-64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.15.0

File hashes

Hashes for pyrudof-0.3.12-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm	Hash digest
SHA256	`e0a8f40635cd408a9d1b55fe90123259acfde26b0b7348b34aee6676ee90fdf6`
MD5	`041b855cd1d514131a487ed47e0e8af2`
BLAKE2b-256	`426f280f8f3ac79f15e7d2202631b63e7e0115f8f57479b332b22eaf3781cfec`

See more details on using hashes here.

File details

Details for the file pyrudof-0.3.12-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

Download URL: pyrudof-0.3.12-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Upload date: Aug 26, 2026
Size: 11.5 MB
Tags: CPython 3.7+, manylinux: glibc 2.17+ ARM64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.15.0

File hashes

Hashes for pyrudof-0.3.12-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm	Hash digest
SHA256	`6fb8ec910979be48fdaebddb90fd74b2a89778369c06259f60f106246a8e71b3`
MD5	`bb99587e9468364d26146f3d0fc4bbc3`
BLAKE2b-256	`8adb4fdfbdd66f8b52edf1c9a49545b92c60763f41c9911837d4e753891b941c`

See more details on using hashes here.

File details

Details for the file pyrudof-0.3.12-cp37-abi3-macosx_11_0_arm64.whl.

File metadata

Download URL: pyrudof-0.3.12-cp37-abi3-macosx_11_0_arm64.whl
Upload date: Aug 26, 2026
Size: 10.3 MB
Tags: CPython 3.7+, macOS 11.0+ ARM64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.15.0

File hashes

Hashes for pyrudof-0.3.12-cp37-abi3-macosx_11_0_arm64.whl
Algorithm	Hash digest
SHA256	`72eeb3fb8e65dfa24a007a95ea481bb01a31ae22213ecb78cafcfe3b63076dc3`
MD5	`0540607ddbd73912ec4e54695a966f7c`
BLAKE2b-256	`93f88bb86ca94162bb4af818eb2ccfcff610ee9e646a1e0f1019024af04de0b1`

See more details on using hashes here.

File details

Details for the file pyrudof-0.3.12-cp37-abi3-macosx_10_12_x86_64.whl.

File metadata

Download URL: pyrudof-0.3.12-cp37-abi3-macosx_10_12_x86_64.whl
Upload date: Aug 26, 2026
Size: 10.7 MB
Tags: CPython 3.7+, macOS 10.12+ x86-64
Uploaded using Trusted Publishing? No
Uploaded via: maturin/1.15.0

File hashes

Hashes for pyrudof-0.3.12-cp37-abi3-macosx_10_12_x86_64.whl
Algorithm	Hash digest
SHA256	`fc7aafdf83b433330e9519d3e729a5cd48811174c5e44a7a49f0ead4daca4ff4`
MD5	`dc027741bbb075a14398ee19c017bc66`
BLAKE2b-256	`3b3d866cb23d5353cb0a1a545976d16fac59df7f9a496071e6772ea9a3e7b372`