Skip to main content

Generates OWL, SHACL shapes and SKOS concepts from XML Schema (XSD) files

Project description

XSD2RDF

License

A tool to convert XML Schema (XSD) files into various RDF formats (SHACL, OWL, SKOS) with integrated validation capabilities.

Overview

XSD2RDF allows you to convert XML Schema definitions into:

  • SHACL (Shapes Constraint Language) for RDF data validation
  • OWL (Web Ontology Language) for ontology representation
  • SKOS (Simple Knowledge Organization System) for concept schemes and taxonomies

Features

  • Convert XSD to SHACL, OWL, and SKOS based on integrated principles
  • SHACL shape constraints are linked to SKOS concept schemes when applicable
  • Handle complex XSD structures (choices, unions, complex types, enumerations, etc.)
  • SHACL shapes are validated according to SHACL-SHACL

This repository also includes a validation script to check RDF data against the generated SHACL shapes and SKOS concepts.

Installation

From PyPI

pip install xsd2rdf

From Source

git clone https://github.com/YourUsername/xsd2rdf.git
cd xsd2rdf
python -m pip install poetry
poetry install

Basic Usage

Convert an XSD file to all RDF formats (SHACL, OWL, SKOS):

python -m xsd2rdf -x path/to/schema.xsd

This generates the following files:

  • schema.xsd.shape.ttl (SHACL shapes)
  • schema.xsd.owl.ttl (OWL ontology)
  • schema.xsd.*.skos.ttl (SKOS concept schemes, one file per enumeration)

Command Line Parameters

  • -x, --XSD_FILE: XSD file to be converted
  • -f, --FOLDER: Folder containing non-related XSD files to be converted
  • -o, --OUTPUT_DIR: Output directory for generated files (default: same as XSD file)
  • -a, --ABBREVIATIONS_FILE: File containing custom abbreviations, one per line
  • -d, --debug: Enable debug output
  • -nc, --namespaced-concepts: Use namespaced IRIs for SKOS concepts

Either -x or -f must be specified, but not both. If both are specified, -x takes precedence.

SKOS IRI Options

By default, SKOS concept IRIs are created using a flat structure:

targetnamespace/concepts/conceptschemename_conceptname

With the --namespaced-concepts flag, concepts use a hierarchical structure:

targetnamespace/concepts/conceptschemename/conceptname

Examples

With custom output directory:

python -m xsd2rdf  -x path/to/schema.xsd -o output/directory

With folder containing multiple unrelated XSD files:

python -m xsd2rdf -f path/to/folder

Using a custom abbreviations file:

python -m xsd2rdf -x path/to/schema.xsd -a path/to/abbreviations.txt

A practical way to generate a list of abbreviations on a Windows machine using Powershell is with this command:

 Select-String -Path "c:\Users\mathi\Git\era\xsd2rdf\debug\SFERA_v3.00.xsd" -Pattern "\b[A-Z]{2,}\b" -AllMatches | ForEach-Object { $_.Matches } | ForEach-Object { $_.Value } | Where-Object { $_ -cmatch "^[A-Z]{2,}$" } | Sort-Object -Unique | Where-Object { $_.Length -ge 2 -and $_.Length -le 10 }

Using namespaced concept IRIs:

python -m xsd2rdf -x path/to/schema.xsd --namespaced-concepts

The abbreviations file should contain one abbreviation per line. These abbreviations will be preserved as uppercase when creating human-readable labels from camelCase or PascalCase strings.

Validation

This feature is only available from source as it is meant for development purposes.

Prerequisites:

  • Create sample data for validation schema.xsd.shape.ttl in the same directory as the xsd file

To validate RDF data against SHACL shapes with SKOS concepts:

python shacl-validation.py path/to/schema.xsd

This will:

  1. Load the data from schema.xsd.sample.ttl
  2. Include all related SKOS files (schema.xsd.*.skos.ttl)
  3. Perform validation using the generated SHACL shapes (schema.xsd.shape.ttl)
  4. Report results in the command line

Example

Converting an XSD file with enumerations:

python -m xsd2rdf xsd2rdf -x comparison/enumerations.xsd

Validating data using generated shapes and concepts:

python shacl-validation.py comparison/enumerations.xsd

License

EUPL 1.2

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

xsd2rdf-0.7.1.tar.gz (22.1 kB view details)

Uploaded Source

Built Distribution

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

xsd2rdf-0.7.1-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file xsd2rdf-0.7.1.tar.gz.

File metadata

  • Download URL: xsd2rdf-0.7.1.tar.gz
  • Upload date:
  • Size: 22.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for xsd2rdf-0.7.1.tar.gz
Algorithm Hash digest
SHA256 632c02359d57350ae7bb8534262d0eee60b545313daadaf3343aced4c220a4e0
MD5 31dd2f75d6dd8779968cbf1297f8354e
BLAKE2b-256 a64be06bf63c3ee8baac6503f9244da36f2d85700cb743ac183e4ab00a79ee5b

See more details on using hashes here.

File details

Details for the file xsd2rdf-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: xsd2rdf-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for xsd2rdf-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a94d7f880dab9281e7d68705c671cbb3bb44c6bbec2d903cd7e2a06e24847cd
MD5 cc64920a375f807b40ccb8c0c6f3b3af
BLAKE2b-256 2495857356137aa90438370d2d1b9c2833114c5c3eda6a029fcbac960680e848

See more details on using hashes here.

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