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
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyrudof-0.3.14-cp37-abi3-win_amd64.whl.
File metadata
- Download URL: pyrudof-0.3.14-cp37-abi3-win_amd64.whl
- Upload date:
- Size: 10.5 MB
- Tags: CPython 3.7+, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
maturin/1.15.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
142f01302ed694594347fd14343588dbc2d760da3f17114b77d3d024cb8e88b5
|
|
| MD5 |
100da3e379be304d5153d24b7656a9d8
|
|
| BLAKE2b-256 |
7907ca125a49fc181c75939a69bab51fe2678a0bc85c124a172a3ebd1572d054
|
File details
Details for the file pyrudof-0.3.14-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.
File metadata
- Download URL: pyrudof-0.3.14-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
- Upload date:
- Size: 11.9 MB
- Tags: CPython 3.7+, manylinux: glibc 2.17+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
maturin/1.15.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ade3e13b07c72c12e2ba7bc9c8baf8992f1bce8be6544cb5cb7fcabddb261aea
|
|
| MD5 |
9d308e4acf6091f5e52cb0fd2f948e72
|
|
| BLAKE2b-256 |
069c6e270d30844a50df01b8b693a3bad6fcf29b3baa052238bb63d87110a3b3
|
File details
Details for the file pyrudof-0.3.14-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.
File metadata
- Download URL: pyrudof-0.3.14-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
- Upload date:
- Size: 12.0 MB
- Tags: CPython 3.7+, manylinux: glibc 2.17+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
maturin/1.15.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2f6ca510eb50a372312542399ef5dfd18d403d221704192a1bdf833022beab5e
|
|
| MD5 |
a8639f9136b200107734934945817214
|
|
| BLAKE2b-256 |
60b56f69a055aee592e6a7cf41b3769dc1f9426457a798a9a429b141c0a6f2cb
|
File details
Details for the file pyrudof-0.3.14-cp37-abi3-macosx_11_0_arm64.whl.
File metadata
- Download URL: pyrudof-0.3.14-cp37-abi3-macosx_11_0_arm64.whl
- Upload date:
- Size: 10.7 MB
- Tags: CPython 3.7+, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via:
maturin/1.15.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d6b148d363a5c8ce1cf89a19af28829fea06f49a03bed528248d76161cd940c2
|
|
| MD5 |
0954b315d04dc5babc63811d825145b3
|
|
| BLAKE2b-256 |
046c5196e337e782b3bce875b1833979f53c0603d224cfc55a6bad031233a043
|
File details
Details for the file pyrudof-0.3.14-cp37-abi3-macosx_10_12_x86_64.whl.
File metadata
- Download URL: pyrudof-0.3.14-cp37-abi3-macosx_10_12_x86_64.whl
- Upload date:
- Size: 11.1 MB
- Tags: CPython 3.7+, macOS 10.12+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via:
maturin/1.15.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f3a444b3c8e125f50e5473c7a346ad99959ec45a91d5b39b041dc85c9e172a8
|
|
| MD5 |
45df471535d7f29e472a488934cc254f
|
|
| BLAKE2b-256 |
7a7da6c1138f31964eb1e8256aebb547039c25a8d88e379c58b68000c7fc5137
|
