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 (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
  • Optional Step: Create a Virtual Environment
  • 1. Using pip (from PyPI)
  • 2. Using poetry (from source)
• CLI Validation
  • 1. Using the installed package
  • 2. Using poetry
• Programmatic Validation
• How It Works
  • Validation profile selection

Resources

• Writing a new profile
  • Learning SHACL
  • Setting up profile files and tests
  • Running validator & tests during profile development
• API documentation
  • Core Services
    • RO-Crate validation
      • validate()
    • RO-Crate profiles
      • get_profiles()
      • get_profile()
  • Core Models
    • RO-Crate
      • ROCrate
        • ROCrate.uri
        • ROCrate.metadata
        • ROCrate.size()
        • ROCrate.list_files
        • ROCrate.has_descriptor()
        • ROCrate.has_file()
        • ROCrate.has_directory()
        • ROCrate.get_file_size()
        • ROCrate.get_file_content()
        • ROCrate.get_external_file_content()
        • ROCrate.get_external_file_size()
        • ROCrate.new_instance()
    • Profiles, Requirements, and Checks
      • Profile
        • Profile.path
        • Profile.identifier
        • Profile.name
        • Profile.token
        • Profile.uri
        • Profile.comment
        • Profile.version
        • Profile.is_profile_of
        • Profile.is_transitive_profile_of
        • Profile.parents
        • Profile.siblings
        • Profile.readme_file_path
        • Profile.profile_specification_file_path
        • Profile.severity
        • Profile.description
        • Profile.requirements
        • Profile.get_requirements()
        • Profile.get_requirement()
        • Profile.get_requirement_check()
        • Profile.get_by_identifier()
        • Profile.get_by_uri()
        • Profile.get_by_name()
        • Profile.get_by_token()
        • Profile.get_sibling_profiles()
        • Profile.all()
      • Requirement
        • Requirement.__init__()
        • Requirement.order_number
        • Requirement.identifier
        • Requirement.__eq__()
        • Requirement.__ne__()
        • Requirement.__hash__()
        • Requirement.__lt__()
        • Requirement.__repr__()
        • Requirement.__str__()
        • Requirement.__ge__()
        • Requirement.__gt__()
        • Requirement.__le__()
        • Requirement.__weakref__
      • RequirementCheck
    • Severity
      • Severity
        • Severity.OPTIONAL
        • Severity.RECOMMENDED
        • Severity.REQUIRED
      • RequirementLevel
      • LevelCollection
        • LevelCollection.OPTIONAL
        • LevelCollection.MAY
        • LevelCollection.REQUIRED
        • LevelCollection.SHOULD
        • LevelCollection.SHOULD_NOT
        • LevelCollection.RECOMMENDED
        • LevelCollection.MUST
        • LevelCollection.MUST_NOT
        • LevelCollection.SHALL
        • LevelCollection.SHALL_NOT
    • Validation
      • ValidationSettings
        • ValidationSettings.profiles_path
        • ValidationSettings.profile_identifier
        • ValidationSettings.enable_profile_inheritance
        • ValidationSettings.abort_on_first
        • ValidationSettings.disable_inherited_profiles_reporting
        • ValidationSettings.disable_remote_crate_download
        • ValidationSettings.requirement_severity
        • ValidationSettings.requirement_severity_only
        • ValidationSettings.allow_requirement_check_override
        • ValidationSettings.disable_check_for_duplicates
        • ValidationSettings.skip_checks
        • ValidationSettings.to_dict()
        • ValidationSettings.rocrate_uri
        • ValidationSettings.parse()
      • ValidationContext
        • ValidationContext.ro_crate
        • ValidationContext.validator
        • ValidationContext.result
        • ValidationContext.settings
        • ValidationContext.publicID
        • ValidationContext.profiles_path
        • ValidationContext.requirement_severity
        • ValidationContext.requirement_severity_only
        • ValidationContext.rocrate_uri
        • ValidationContext.fail_fast
        • ValidationContext.rel_fd_path
        • ValidationContext.get_data_graph()
        • ValidationContext.data_graph
        • ValidationContext.inheritance_enabled
        • ValidationContext.profile_identifier
        • ValidationContext.allow_requirement_check_override
        • ValidationContext.disable_check_for_duplicates
        • ValidationContext.profiles
        • ValidationContext.target_profile
        • ValidationContext.get_profile_by_token()
        • ValidationContext.get_profile_by_identifier()
      • ValidationResult
        • ValidationResult.context
        • ValidationResult.rocrate_uri
        • ValidationResult.validation_settings
        • ValidationResult.executed_checks
        • ValidationResult.get_executed_check_result()
        • ValidationResult.skipped_checks
        • ValidationResult.issues
        • ValidationResult.get_issues()
        • ValidationResult.get_issues_by_check()
        • ValidationResult.has_issues()
        • ValidationResult.passed()
        • ValidationResult.add_issue()
        • ValidationResult.failed_requirements
        • ValidationResult.failed_checks
        • ValidationResult.get_failed_checks_by_requirement()
        • ValidationResult.get_failed_checks_by_requirement_and_severity()
        • ValidationResult.to_dict()
        • ValidationResult.to_json()
      • CheckIssue
        • CheckIssue.message
        • CheckIssue.level
        • CheckIssue.severity
        • CheckIssue.check
        • CheckIssue.violatingEntity
        • CheckIssue.violatingProperty
        • CheckIssue.violatingPropertyValue
      • Event
      • EventType
        • EventType.VALIDATION_START
        • EventType.VALIDATION_END
        • EventType.PROFILE_VALIDATION_START
        • EventType.PROFILE_VALIDATION_END
        • EventType.REQUIREMENT_VALIDATION_START
        • EventType.REQUIREMENT_VALIDATION_END
        • EventType.REQUIREMENT_CHECK_VALIDATION_START
        • EventType.REQUIREMENT_CHECK_VALIDATION_END
      • Subscriber
        • Subscriber.update()
    • Errors
      • ROCValidatorError
      • ProfilesDirectoryNotFound
        • ProfilesDirectoryNotFound.profiles_path
      • InvalidProfilePath
        • InvalidProfilePath.profile_path
      • ProfileNotFound
        • ProfileNotFound.profile_name
        • ProfileNotFound.message
      • ProfileSpecificationNotFound
        • ProfileSpecificationNotFound.spec_file
      • ProfileSpecificationError
        • ProfileSpecificationError.message
      • DuplicateRequirementCheck
        • DuplicateRequirementCheck.check_name
        • DuplicateRequirementCheck.profile_name
      • InvalidSerializationFormat
        • InvalidSerializationFormat.serialization_format
      • BadSyntaxError
        • BadSyntaxError.message
        • BadSyntaxError.path
        • BadSyntaxError.code
      • ValidationError
        • ValidationError.message
        • ValidationError.path
        • ValidationError.code
      • CheckValidationError
        • CheckValidationError.check
      • ROCrateInvalidURIError
        • ROCrateInvalidURIError.uri
        • ROCrateInvalidURIError.message
      • ROCrateMetadataNotFoundError
        • ROCrateMetadataNotFoundError.message
        • ROCrateMetadataNotFoundError.path
  • Python Check API
    • Requirement Class
      • PyRequirement
    • Decorators
      • requirement()
      • check()
• Index