Welcome to rocrate-validator’s documentation!

rocrate-validator (available as roc-validator on PyPI) is a Python package to validate RO-Crates against different profiles, including the base RO-Crate profile and various extensions.

Features

• Validates RO-Crates against the profiles they declare to conform to. Currently, validation for the following profiles is implemented:

  • RO-Crate 1.3 (base profile, used by default)

  • RO-Crate 1.2 (base profile)

  • RO-Crate 1.1 (base profile)

  • Workflow RO-Crate

  • Workflow Testing RO-Crate

  • Workflow Run Crate

  • Process Run Crate

  • Provenance Run Crate

• Filters profile validation rules by requirement level (i.e., REQUIRED, RECOMMENDED, OPTIONAL).

• Provides detailed information about the issues found during validation.

• Supports validation of RO-Crates stored locally as directories or as ZIP archives (.zip files) or remotely accessible via HTTP or HTTPS (e.g., http://example.com/ro-crate.zip).

• Supports CLI-based validation as well as programmatic validation (so it can easily be used by Python code).

• Extensible framework: new RO-Crate profiles can be added, implementing profile requirements as SHACL shapes and/or Python code.

Note: this software is still work in progress. Feel free to try it out, report positive and negative feedback. We also welcome contributions, but we suggest you send us a note (e.g., by opening an Issue) before starting to develop any code. The implementation of validation code for additional RO-Crate profiles would be particularly welcome.

Getting Started

• Installation
• CLI Validation
• Programmatic Validation

Using the Validator

• How It Works
• Package modes and validation scope
• Validation Profiles
• Offline Mode and HTTP Caching
• API documentation
• Validation examples
  • Try RO-Crate metadata validation with a Python dictionary

Profile Development

• Writing a new profile
• Optimizing SHACL target selection
• Graph transformers
• Building and previewing the documentation

About

• Acknowledgements