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_outputsubstrings (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.tomlstores metadata (key,source_file,title,description,category,files,expected_output,skip_test).examples/**/*.pystores the executable code.tests/test_examples.pyanddocs/generate_examples_doc.pyboth 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 examplebindings/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.
1 maintainer
Metadata
1 maintainer
Release files for pyrudof 0.3.20
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| pyrudof-0.3.20-cp37-abi3-win_amd64.whl | CPython 3.7 | abi3 | Windows x86-64 | Details |
| pyrudof-0.3.20-cp37-abi3-manylinux_2_34_x86_64.whl | CPython 3.7 | abi3 | Linux glibc 2.34+ x86-64 | Details |
| pyrudof-0.3.20-cp37-abi3-manylinux_2_34_aarch64.whl | CPython 3.7 | abi3 | Linux glibc 2.34+ ARM64 | Details |
| pyrudof-0.3.20-cp37-abi3-macosx_13_0_x86_64.whl | CPython 3.7 | abi3 | macOS 13.0+ x86-64 | Details |
| pyrudof-0.3.20-cp37-abi3-macosx_13_0_arm64.whl | CPython 3.7 | abi3 | macOS 13.0+ ARM64 | Details |
Total release size: 98.5 MB
Release files / pyrudof-0.3.20-cp37-abi3-win_amd64.whl
| Download URL | pyrudof-0.3.20-cp37-abi3-win_amd64.whl |
|---|---|
| Size | 18.4 MB |
| Tags | CPython 3.7 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
15c324ab207faf0cfa035c6ab9954721aa8c26ac0867951105e7ca4364344ce8
|
|
BLAKE2b-256 checksum How to use checksums |
0e30f9078553fd7859119240e90a5a8adb2d2e4668b527e29c0c909dc3b73a7e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / pyrudof-0.3.20-cp37-abi3-manylinux_2_34_x86_64.whl
| Download URL | pyrudof-0.3.20-cp37-abi3-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 23.7 MB |
| Tags | CPython 3.7 Linux glibc 2.34+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
8c90303065d885d9d8e06fdb94cbf3eeb6f6b08f9ea9b7c26f7812dc32387d23
|
|
BLAKE2b-256 checksum How to use checksums |
637d94e1500a23156ff3264617c51d96034f9d28a2b57584528ce3777a0d2c46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / pyrudof-0.3.20-cp37-abi3-manylinux_2_34_aarch64.whl
| Download URL | pyrudof-0.3.20-cp37-abi3-manylinux_2_34_aarch64.whl |
|---|---|
| Size | 23.4 MB |
| Tags | CPython 3.7 Linux glibc 2.34+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
ea3e97447be924617312a90390ab037bce8a9657fec479ce77de75bc6d2a19d7
|
|
BLAKE2b-256 checksum How to use checksums |
a53871bd28c3c11096b3826c3e454866fcda72a531e810b8d27123626c38f579
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / pyrudof-0.3.20-cp37-abi3-macosx_13_0_x86_64.whl
| Download URL | pyrudof-0.3.20-cp37-abi3-macosx_13_0_x86_64.whl |
|---|---|
| Size | 16.8 MB |
| Tags | CPython 3.7 abi3 macOS 13.0+ x86-64 |
|
SHA-256 checksum How to use checksums |
811f4cab7e12672579819a0664a78af41c14c8245b9e223e7aa0583a8f3e8cfc
|
|
BLAKE2b-256 checksum How to use checksums |
010d703fc75a10f3946081a0bbb8904de89d86c454de0361f082f9f7d1a8caef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
Release files / pyrudof-0.3.20-cp37-abi3-macosx_13_0_arm64.whl
| Download URL | pyrudof-0.3.20-cp37-abi3-macosx_13_0_arm64.whl |
|---|---|
| Size | 16.2 MB |
| Tags | CPython 3.7 abi3 macOS 13.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
e62bb425178e7d8eb972d6e6485b54bcc8d8cd53bc0c5b2fa73d9870c2c80f13
|
|
BLAKE2b-256 checksum How to use checksums |
7161ed530399b295691218e3583ba0b1ccd374836d8a1ddb80c86d1bab368f2a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
maturin/1.15.0
|
