All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Full changelog: https://github.com/kikkomep/rocrate-validator/compare/0.13.0...0.13.1
- chore(deps): update dependencies in poetry.lock, including PySHACL 0.40.2 and Starlette 1.10.0 (c27cf006)
- build(deps): allow Rich versions below 15 for compatibility with Flower 1.32+ (64ded524)
- build(deps): bump crate-ci/typos (e022f654)
- fix(profiles): use resolved IDs for web entity checks (49638aa7)
- fix(crate): resolve entity IDs against JSON-LD
@base(e9ef43ed) - fix(uri): handle local paths with URI-safe conversion (4bdea490)
Full changelog: https://github.com/kikkomep/rocrate-validator/compare/0.12.2...0.13.0
- Profile detection now explains suggested profiles and lets users confirm them before validation (2b0cbaae).
- Opt-in extra checks extend validation beyond the standard profile rules (e3ef940b, 8b0d1fcd).
- Automatic package-type detection and CLI selection distinguish attached and detached crates; reports show the package type and validation scope (bebee42b, 06c29319, 595fcc8e).
- Dictionary metadata can be validated against files in a local package root (86a84ea5).
- Reusable validation preparation avoids repeating setup across validation calls (6bd45817).
- Workflow Run Crate checks require an action using the main entity as its instrument and support additional action types (d88a1ce8, 57a1413f).
- Reusing prepared profiles across crates preserves absolute IRIs, relative identifiers, URI paths, and SHACL class targets (dc258c3a, 5edb72e4, 230856a1).
- Package checks handle attached metadata-only inputs and dictionary metadata consistently; reports identify the local package root (858a0d3c, 0c9967c0, 545e7448).
- Malformed profile hints and invalid JSON produce clearer messages, while unexpected detection errors are no longer hidden (756dbb4e, 7a95271f).
- Removed duplicate extra-check tables from CLI output (9d7d4b76).
- Fixed Sphinx crashes when including README sections and improved dark-mode readability (153efa65, f9b8822d).
- Redesigned documentation with the Shibuya theme, clearer navigation, and live preview with automatic rebuilds (c0212aaa, 83a84c4a, d955005f).
- Expanded guides for profile detection, extra checks, package modes, and reusable validation (05f0dc30, 2f4f97c5, 3b1a66e9, 4c88ced7).
- Reuse prepared profiles across crate bases and selected profiles when computing statistics, reducing repeated profile loading and preparation (08d317e1, 401b8d64).
Full changelog: https://github.com/kikkomep/rocrate-validator/compare/0.12.1...0.12.2
- fix(profiles): handle absolute file URI Data Entity identifiers (afb7b0d2)
- fix(profiles): accept declared compact IRIs in JSON-LD properties (050dd18a)
- test(profiles): cover absolute file URI Data Entities (9f12712b)
- test(jsonld): cover compact IRI prefixes across RO-Crate profiles (cdb6e04e)
Full changelog: https://github.com/kikkomep/rocrate-validator/compare/0.12.0...0.12.1
- chore(deps): group weekly dependency updates (088d7f43)
- test(validation): cover metadata descriptor targeting across core versions (a09b795a)
- ci(deps): configure weekly Dependabot updates for GitHub Actions (039f8f13)
- ci(release): update Sigstore action to v3.5.0 (42896acd)
- ci(typos): align CI and pre-commit on v1.50.3 (d531e457)
- ci(actions): update setup-python to v7 (0b33ccf6)
- ci(actions): update checkout to v7 (e0ccc19d)
- ci: replace release check polling with native workflow dependency (54560d6a)
- test(validation): verify effective overlay IDs in text reports (c51cf5de)
- test(validation): cover profile Root Data Entity hasPart cases (865f39c7)
- fix(profiles): identify metadata descriptors by filename suffix (06f5520e)
- fix: correct two check descriptions (e150f0dc)
- fix(validation): show overlay check IDs in text reports (def3ded1)
- fix(validation): report missing hasPart Data Entities accurately (6c065b84)
Full changelog: https://github.com/kikkomep/rocrate-validator/compare/0.11.4...0.12.0
- The default validation profile is now
ro-crate-1.3(previouslyro-crate-1.1). Since 1.3 is self-contained, validation now applies 95 requirements instead of 30; crates declaring the 1.1 context fail thero-crate-1.3_2.2check under the default profile. This primarily affects API users whenprofile_identifieris omitted. CLI auto-detection is unchanged unless no profile is detected or--no-auto-profileis used. To keep the previous behaviour, explicitly selectro-crate-1.1withprofile_identifieror-p ro-crate-1.1(b6199c60).
- feat(profiles): support rule overlays through
validator:isRuleOverlayOf, allowing a target profile to reuse checks from a direct parent while retaining source provenance and reporting target-relative effective identities. Overrides defined by the target profile match parent checks by(name, severity)(e92e826b). - feat(profile-checks): add an extensible profile consistency framework that detects duplicate check identities, invalid overlay relationships, and ambiguous checks inherited from multiple sources (59a66303, 99748956).
- feat(cli): add
profiles check <PROFILE_IDENTIFIER>and automatic profile validation, with--no-profile-checksand the corresponding API setting available as explicit opt-outs (a4eb3fd2, f430b2b9). - feat(api): expose effective provenance for checks defined by the target profile, inherited checks, and replacement checks in validation events, issues, statistics, and skipped-check results (a7fabdb4).
- feat(cli): show source and effective check identities and their provenance relationships in verbose
profiles describeoutput (b4108c16). - feat(profiles): provide comprehensive RO-Crate 1.3 validation coverage for metadata descriptors, entities, workflows, and detached or referenced crates (5a98e4e0, e2bc9846, 41cd9fc3, bc2f76e4).
- feat(validation): support tri-state check outcomes and declared dependencies between checks, and propagate dependency outcomes through validation (80495af4, 77c4741b, 7a5a1749).
- feat(cli): report structured skipped-check reasons in validation results and aggregate them in JSON output (c3044802, 035e5485, 892460ec, 70c47ab5).
- feat(graph): add an extensible graph-transformer pipeline for preparing validation graphs and selecting candidate entities from SHACL shapes (80531e0a, 74aca87e, 3a8d0cf0, 822c26be).
- feat(profiles): validate Schema.org IRI protocols with SHACL (7f6e8032).
- feat(validation): propagate check execution errors and render them safely in the CLI (f2e7f36a, 48bf2968).
- refactor(validation): resolve bare profile tokens to the highest available version using numeric ordering and store the resolved identifier so downstream consumers use the applied profile (7b782975).
- refactor(cli): use consistent styling for profile names, identifiers, check names, and provenance labels across profile commands (40e7fe4e, 2316a430).
- refactor(shacl): separate graph-transformer implementations from the SHACL validation core (21590fe8, a46eb34f).
- refactor(profile): declare RO-Crate 1.3 as a rule overlay over RO-Crate 1.2 and rename the overlay
property to
isRuleOverlayOf(9dd09229, 82df8dca).
- fix(validation): preserve general-to-specific overlay traversal and source check execution order;
resolve the overlay target from
profile_identifierand preserve inherited dependencies and skip settings independently of profile loading order (a73f90da, dbea5738, 996b52aa, 709e7564). - fix(shacl): load each overlay source graph once and evaluate the merged shapes graph at the target profile (22455d3b).
- fix(profiles): reject ambiguous effective identities instead of implicitly selecting one inherited check, and disambiguate legacy duplicate check names within existing profiles (f00ea8c1, 16709a69).
- fix(graph): treat
schema:additionalTypeas a reference predicate (ce4856c9). - fix(validation): correct skipped-check counts, align check statistics with validation outcomes, and keep batched SHACL results synchronized with live progress (0416446b, 39f3f640, d4ab2cb8).
- docs(profiles): document ordinary inheritance, check overrides, rule overlays, deactivation, and source versus effective identities with concrete SHACL and Python examples (3dd0b793).
- docs(api): document effective check provenance for composed profiles (12485e89).
- docs(graph): document the graph-transformer extension points and SHACL implementation catalog (782f74c4, fc455598).
- perf(validation): cache profile consistency results and effective check provenance within a validation session to avoid repeated resolution work (c0b65cad, 8df06f12).
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.11.3...0.11.4
- feat(rocrate): add validation for singleton arrays in compacted entity properties (9d8078c7, 675cdb27, 2aa6bcba)
- refactor(metadata): expose raw metadata descriptor bytes for encoding checks (e18e24ef)
- refactor(versioning): use a shared distribution name when resolving the package version (e57e2ea7)
- fix(validation): skip metadata-dependent profile checks when descriptors are missing or unreadable instead of reporting misleading errors (b302b5cd, 2444e97a)
- fix(metadata): handle missing metadata descriptors without leaking
FileNotFoundError(e1217fda) - fix(profile): skip descriptor encoding validation in metadata-only mode and narrow exception handling (acb715bf, 9411c86c)
- fix(rocrate): normalize singleton-array
mainEntityvalues in workflow crates (568b8c41) - fix(profiles): use the canonical namespace for the RO-Crate 1.2 ontology (d9e115cb)
- fix(versioning): resolve the package version when installed outside a Git checkout (856546a4)
- docs(profiles): document SHACL target selection optimization (14058e67)
- perf(profiles): replace custom SPARQL targets with SHACL Core targets (bb4d0317)
- perf(profiles): reduce duplicate and cross-product work in contextual-entity target queries (be6aa6ff, 88ded678)
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.11.2...0.11.3
- fix(cli): disable Rich word-wrap in the JSON validation report to prevent literal newlines inside quoted strings that produced invalid JSON (ab66c773)
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.11.1...0.11.2
- fix(cli): use Path type for
--output-fileoption so Click returns apathlib.Pathrather than a plain string (31f3785e)
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.11.0...0.11.1
- feat(validation): support unconditional validation abort so a check can stop the entire run when metadata is unreadable, instead of letting downstream checks emit false positives (40f9a568)
- feat(profiles): detect invalid JSON in the file descriptor and abort validation with a precise parse error message and line/column info (05c7b258)
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.10.0...0.11.0
- feat(profiles): add RO-Crate 1.2 validation profile with comprehensive SHACL shapes and Python checks covering required/recommended/optional properties for Root Data Entity, Data Entities, File Data Entities, Web Data Entities, Contextual Entities, SoftwareApplication, ComputerLanguage, Organization, License, Person, Workflow, Script entities, and detached/referenced RO-Crates (cb7d3653)
- feat(profiles/ro-crate-1.2): check recommended entity name and base type for all entities (41ef61f6, c464f526)
- feat(profiles/ro-crate-1.2): check recommended reachability of metadata entities (b4935f81)
- feat(profiles/ro-crate-1.2): check additional license, funder property, and hasPart for Data Entities (2f673d82, bbe137e1, 364cc549)
- feat(profiles/ro-crate-1.2): check resolvable identifiers via cite-as property and downloadability via Signposting (468fe8de, 7b459f34, bf67d10a)
- feat(profiles/ro-crate-1.2): check UTF-8 encoding of metadata descriptor and recommended file descriptor naming convention (00f842b7, 74589852)
- feat(profiles/ro-crate-1.2): check recommended version property of Software entities and optional alternateName for SoftwareApplication/ComputerLanguage (2dfd023e, 364ec58c)
- feat(core): add support for detached metadata files (JSON/JSON-LD as crate source) (2c7036ac, 5b6ffea6)
- feat(cli): add
--check-availability/--no-check-availabilityflags for availability control (5b6ffea6) - feat(shacl): inject default prefixes and improve BNode disambiguation (2fbfa047)
- feat(http): reconfigure existing HttpRequester singleton instead of recreating it (80b15c95)
- ci: add pre-commit configuration with ruff, typos, mypy, and pylint hooks (e6c3ea46, 9fe1a05f, 2f498481)
- ci: add CSpell dictionary for project-specific terms (3790e4e9)
- refactor(models): split models.py into a package with cohesive submodules (e662801e)
- refactor(rocrate): split rocrate.py into a package with cohesive submodules (17c6720e)
- refactor(profiles): move RO-Crate 1.1 validation profile to dedicated directory (71009cc1)
- refactor(shacl): extract node-shape registration helper and helpers to lower complexity (035494bd, 4d0a57b6)
- refactor(cli): extract EventDispatcher to route validation events and expose show_overall_result (a6af0e99, f379c448)
- refactor: migrate from flake8 to ruff; add ruff.toml configuration with mccabe, eradicate, and pylint-parity rules (4db08800, cfe6ec4f)
- style: modernize type hints with PEP 604 union syntax (X | Y, X | None) across the codebase (98426c09, 95e05ebb)
- style: move type-only imports to TYPE_CHECKING blocks and fix import order (b05efd93, fb928d07, d7203517, 7871bb18)
- refactor: replace os.path operations with pathlib equivalents across the codebase and tests (67bb87d5, b105c0ed, e50fe0dc)
- refactor: reduce cyclomatic complexity across validation checks, CLI, and cache modules (f1c407ee, 276b9643, e3ed5048, d9952040, 4614940d)
- refactor: replace manual loops with comprehensions and extend(), enumerate, and or-idioms (1c4bec98, 4385777c, 0c730230, 50de8a2e)
- refactor: replace relative imports with absolute imports (74b31374)
- refactor: use context-managed lock instead of manual acquire/release (2d7984e8)
- refactor(console): match rich Console.print signature (5339b33e)
- build: configure poetry to create in-project virtualenv (ffcde868)
- build(ruff): set target-version = py310 to align linter with project (4c3501dd)
- build(pylint): whitelist SHACL/JSON-LD names and disable R0801 (5339b33e)
- fix(http): resolve session method lazily and reconfigure HttpRequester in place (9a82482d, c9b4cc2f, 80b15c95)
- fix(profiles/ro-crate-1.2): correct contentSize check for File DataEntity (5e7f3120)
- fix(profiles/ro-crate-1.2): fix conformsTo check for File DataEntity and Root DataEntity identifier (415bd27d, 919a1421)
- fix(profiles/ro-crate-1.2): remove duplicate Web Data Entity checks and fix shape targets (fbed5c82, 6877898a)
- fix(profiles): raise ProfileNotFound when profile is not found in get_profile (fdbbc1e2)
- fix(profiles): show actual size in Web Data Entity contentSize mismatch message (51e7a767)
- fix(models): add missing return statement and call as_json() before as_graph() (ff196b4a, 667d8b93)
- fix(typing): add None guards, implicit Optional annotations, and missing type annotations across the codebase (4156d7d8, dda588ae, e39e28b1)
- fix(shacl): return real bool from SHACLCheck.check and is_external_reference (982e3257, 896b419d)
- fix(logging): fall back to WARNING for unknown log level names (b586b973)
- fix(progress): respect severity threshold in progress tracking (43ce7a15)
- fix(utils): fix logger factory and add exception chaining (5afa76a3, f672de2b)
- fix(utils): improve dynamic module loading to avoid collisions (997a3c5d)
- fix(services): guard original_data_path against None on restore (bcbbdc34)
- fix(isa-ro-crate): terminate isa-ro-crate:Data triple in ontology.ttl (f4fd0446)
- fix(test): use str() instead of as_uri() for local crate paths and fix context manager on Path (4b3d5847, b15e301b)
- fix: add explicit encoding="utf-8" to open() calls and read_text (c73e6b2e, 8de1aa68)
- fix: add proper exception chaining in except blocks (b18d02ac)
- fix: use bare raise instead of raise e and ValueError instead of generic Exception (ba2ef280, 5d00a4fc)
- chore: remove flake8 config and dependency (c7286047, 35095f82)
- chore(cspell): remove stale ignore entries (85d3e9b8)
- docs(readme): add Development section with pre-commit usage (686db620)
- docs(log): convert usage example from commented code to docstring (d21aa857)
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.9.0...0.10.0
- feat(cli): add offline mode with an
--offlineflag and an HTTPcachesubcommand to validate RO-Crates without network access (e296f10, f8b99bc) - feat(utils): add a cache-aware JSON-LD document loader and HTTP cache warm-up from profile artifacts (eedabf1, 949ec6f)
- feat(utils): add offline mode and cache management to
HttpRequester, with configurable cache path (c92d88c, 7c9e825) - feat(core): support offline mode when downloading remote RO-Crates (57eceb5)
- feat(cli/cache): add
cache list(aliasls) and allow caching of explicit URLs viacache warm(f9b43ae, 6925d55) - feat(cli): extend the
describecommand to describe individual requirement checks (f3fb7f3) - feat(model): add a
SourceSnippetclass andRequirementCheck.get_source_snippet, implemented for both SHACL and Python checks (9f48674, 25bc7b4, fe740e4) - feat(checks): support a
deactivatedflag onRequirementCheckto override/deactivate checks by name for Python and SHACL (dd84c32, 4196f0e) - feat(rocrate): add
check_availability()withAvailabilityStatuson entities and granular remote-scheme classification (76e92a4, 469bbe5) - feat(checks): handle
UNAUTHORIZED/UNCHECKABLEweb data entities as warnings (0196dc9) - feat(uri): add an
is_external_reference()scheme detector (62f89c0) - feat(model): extend the
Profilemodel to compute descendants (a9783ce) - ISA profile: add RDF classes for ISA types and a dedicated
Processclass for process checks (3ff4245, e3fda59, c3e2d5f)
- refactor(models): introduce pre/post internal validation hooks on
Validator(e43364b) - refactor(SHACL): rewrite
build_node_subgraphas an iterative BNode traversal (23164b7) - refactor(errors): accept
str,PathorURIinROCrateInvalidURIError(0b8289b) - refactor(cli/cache): drop the
Statuscolumn from thecache listtable (392df1a) - feat(constants): default the HTTP cache to never expire (419fece)
- fix(shacl): build property shape subgraphs by reachability and derive
NodeShapelevel from nestedPropertyShapes (f1c0cfd, 50448145) - fix(shacl): evaluate inherited shapes for zero-shape target profiles (bcb5cac)
- fix(shacl): drop sub-threshold PySHACL violations at the source (254fb88)
- fix(core): filter failed requirements/checks by the configured severity (a306f7f)
- fix(models): forward
extra_profiles_pathwhen computing validation statistics (7b3e8bc) - fix(uri): treat
file://URIs with a non-local authority as remote (63acb6a) - fix(cli/cache): resolve profile tokens in
cache warmand avoidstream=Truewhen fetching remote crates (7926832, 33012b6) - fix(validation): report offline cache misses once per URL (757b86a)
- fix(ISA): correct the error message for a bad position in
HowToStep(03a32fc)
- docs: add a dedicated documentation page for the cache and offline mode features (e10c3b5)
- docs(profiles): document check override-by-name and deactivation (0b6bff7)
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.8.1...0.9.0
- feat(profiles/isa): add the ISA RO-Crate profile, with checks and tests for Investigation, Study, Assay, Process, Protocol, Sample, Data, Person and PropertyValue entities (852fb23, d62e214, 727b6f0)
- feat(cli): add CLI options to configure the HTTP cache (
--cache-path,--cache-max-age) (564230f) - feat(model): enable cache configuration in
ValidationSettings(b2b47ba) - feat(utils): extend the
HttpRequesterconstructor to support cache configuration parameters (2f2a873) - feat(ro-crate): refine the constraint enforcing metadata descriptor existence (2c6ea76)
- feat(file-descriptor): add an internal remote-context retrieval method supporting the alternate
Linkheader (f8b0e55)
- refactor(ro-crate): relax the
ROCrateMetadataFileDescriptorclass definition (61ddbb5) - refactor(file-descriptor): route checks through the new remote-context retrieval method (0ce2619)
- chore(utils): increase the session cache max age to 300 seconds (36ca0ac)
- ci(gh-actions): update outdated GitHub Actions (d565c5d)
- fix(ro-crate): target metadata descriptor shapes by class and select the candidate descriptor via SPARQL (8219f27, 39bd761, 1a91aa4)
- fix(shacl): extract
@basefrom the JSON-LD document for ontology parsing (57f5c54) - fix(SHACL-core): improve SHACL violation parsing with better error handling (90a9f06)
- fix(file-descriptor): accept
application/jsonand treat theLinkheader case-insensitively for remote context retrieval (fe5ba1c) - fix(file-descriptor): refine the compacted JSON-LD key validation logic (45a7017)
- fix(core): allow terms defined by context prefixes (5fe8171)
- fix(core): fix output formatting (523fbf4)
- docs(cli): document the
-1value for no cache expiration in the--cache-max-agehelp (c5848bc)
Full changelog: https://github.com/crs4/rocrate-validator/compare/0.8.0...0.8.1
- refactor(core): rename flag
disable_inherited_profiles_reportingtodisable_inherited_profiles_issue_reporting(daebea1) - refactor(core): set
disable_inherited_profiles_issue_reportingto disabled by default (c8e7de7) - refactor(core): skip inherited profile event notifications when issue reporting is disabled (c8ad7b9)
- build(poetry): allow using the latest PySHACL version (fde97be)
- fix(cli): fix
richdeprecation warning (dbdfae5) - fix(core): ensure skipped checks are reported properly (471745b)
- fix(cli): wrong param name (38f22ff)
- fix(core): ensure skip_checks is defined before use (04988b1)
- fix(core): enable skipping of Python checks (efcad8b)
- fix(core): enable skipping of SHACL checks (9141a72)
- fix(core): exclude skipped checks from stats (4a27eb9)
- fix(core): remove inherited checks from stats when
disable_inherited_profiles_issue_reportingis set (f6e15b7) - fix(cli): make the
disable_profile_inheritanceCLI flag affect only reporting (not loading) of inherited profiles (d6f9192)
- chore: filter
rdflibJSON-LD deprecation warnings (c6da40a)
- docs(core): clarify the proper usage of the
enable_profile_inheritanceflag (cd3af57) - docs(core): improve code documentation with additional comments (cd03486)
- feat(cli): detect environment and properly handle Console initialization
- feat(profiles/ro-crate): check if the JSON-LD context can be loaded
- feat(profiles/ro-crate): check for the compacted JSON-LD format of the file descriptor
- feat(profiles/ro-crate): check recommended existence of absolute local data entities
- feat(profiles/ro-crate): update check to skip absolute paths
- feat(core): extend entity model to detect local and relative paths
- feat(profiles/ro-crate): check for the existence of data entities
- feat(cli): allow configuring the list of checks to skip via CLI
- feat(core): allow skipping a configurable list of checks
- feat(cli): display the full check identifier when verbose mode is enabled
- feat(core): fix and extend method to fetch entities by type
- feat(core): add utility method to retrieve all data entities
- feat(core): expose path/uri of rocrate entities
- feat(core): add class method to derive data entity path from identifier
- feat(cli): add support for relative root path option
- feat(model): allow instantiating metadata-only RO-Crates
- feat(services): add a service method to validate RO-Crate metadata from a dict
- feat(profiles/ro-crate): extend flat JSON-LD check to support value objects
- feat(core): add factory method to automatically instantiate RO-Crate with the correct subtype
- feat(model): add classes for handling BagIt-wrapped RO-Crates
- refactor(utils): reorganize the
utilspackage structure - refactor(utils): rename
rocv_iotoio_helpers - refactor(utils): move rocv_io into the utils package
- refactor(core): convert utils module into a package
- refactor(io.output): restructure and simplify the formatter classes
- refactor(io.output): simplify Console class
- refactor(cli): restructure CLI output handling logic
- refactor(cli): move and extend the base class to handle console output
- refactor(io.output): move the Pager class to a dedicated module
- refactor(cli): move input methods to the
io.inputmodule - refactor(model): move profile finder to the Profile class
- refactor(core): improve file and directory availability checks
- refactor(core): refactor entity availability check with generic ZIP support and path unquoting
- refactor(cli): remove CLI parameters from the global validation settings
- refactor(core): move the init logic to the
__post__init__method - refactor(profiles/ro-crate): move required properties to a dedicated shape
- refactor(core): declare the function as class level method
- refactor(core): simplify profiles parsing
- refactor(core): rewrite magic method to sort profiles
- refactor(cli): update the short option to skip checks
- refactor(core): use method to identify remote entities
- refactor(core): remove redundant code
- refactor(utils): refactor multiple delegator methods into one
- refactor(core): remove relative imports
- refactor(core): adopt the
HttpRequesterclass - refactor(shacl): only exclude fragment identifiers that refer to the root data entity
- refactor(core): refactor Python detection of local identifiers
- fix(profiles/ro-crate): fix SHACL nodeKind constraint being too strict
- fix(cli): wrong param name
- fix(core): ensure skip_checks is defined before use
- fix(core): enable skipping of Python checks
- fix(core): enable skipping of SHACL checks
- fix(core): exclude skipped checks from stats
- fix(core): remove inherited checks from stats when
disable_inherited_profiles_issue_reportingis set - fix(cli): make the
disable_profile_inheritanceCLI flag affect only reporting - fix(tests): fix unit test assertion
- fix(logging): fix typo
- fix(cli): missing object dump
- fix(core): fix the candidate profiles collection
- fix(io.output): fix import
- fix(io.output): allow initialization of the report layout without an initial state
- fix(cli): fix formatter parameter
- fix(cli): restructure logic to process CLI text output of validation result
- fix(io.output): fix missing padding
- fix(model): fix availability check of external resources
- fix(model): use the custom class for remote Bagit RO-Crate objects
- fix(model): fix initialisation of BagitROCrate objects
- fix(model): fix fallback value for root path
- fix(model): fix initialisation of Bagit objects
- fix(model): fix linter warnings
- fix(model): fix linter warning E999
- fix(profiles/ro-crate): trailing slash for Data Entities is recommended not mandatory
- fix(profiles/ro-crate): fix
sh:messagefor the requireddatePublished
- chore: filter
rdflibJSON-LD deprecation warnings - chore(poetry): fix missing whitespaces
- chore: update copyright notice to 2026
- chore(git): ignore IDE project files
- docs(api): update docs
- docs(profiles): add note about ontology graph support and formal definitions
- docs(io.output): add some note about output formatters
- docs(readme): specify python 3.9 or later
- docs(profiles/ro-crate): add notes on custom validation profiles
- docs(cli): rephrase
--skip-checksoption description - docs(cli): improve description of the
skip-checksoption - docs(cli): add notes about programmatic metadata-only validation
- docs(core): clarify the proper usage of the
enable_profile_inheritanceflag - docs(core): improve code documentation with additional comments
- perf(io.output): remove padding when using using no color console
- perf(cache): optimize Redis connection pooling
- perf(shacl): skip redundant violation messages
- perf(core): compute overrides on the fly
- perf(core): add a method to find a profile by checking its name
- perf(core): add properties to get parents and siblings of a given profile
- perf(core): add getter for sibling profiles
- perf(core): automatically detect overrides during Profile initialization
- perf(core): add support for overrides to the
Profilemodel
- Restore Python 3.13 compatibility
- Allow pyshacl 0.30
- Adjust dependency version ranges for better flexibility
- Upgrade dependencies
- feat(profiles/ro-crate): exclude from the definition of Dataset Data Entities any dataset with a local identifier
- feat(profiles/ro-crate): exclude from the definition of File Data Entities any file with a local identifier
- feat(profiles/ro-crate): including files with local identifiers in the crate is not mandatory
- refactor(shacl): only exclude fragment identifiers that refer to the root data entity
- refactor(core): refactor Python detection of local identifiers
- feat(core): allow avoiding duplicated events
- refactor(shacl): fix issue notifications
- chore(core): update log and comment messages
- fix(shacl): fix return value of SHACL requirement check
- fix(core): do not skip overridden checks of the target profile
- fix(shacl): keep track of the checks that have been notified
- feat(utils): add multithreading support
- feat(utils): add a singleton class to handle HTTP requests
- refactor(utils): refactor multiple delegator methods into one
- refactor(core): remove relative imports
- refactor(core): adopt the
HttpRequesterclass
- fix(cli): don't skip overridden checks of the target profile
- chore: update copyright notice
- feat(core): add method to list the entries of a ZIP archive
- feat(core): add getter for archive entry info
- refactor(core): allow empty files and directories within a ZIP file
- Acknowledge CN HPC
- fix(core): update logic to check the availability of archive folders
- fix(cli): fix typo
- fix(core): fix the candidate profiles collection
- chore: update github action version
- feat(profiles/ro-crate): check if the JSON-LD context can be loaded
- feat(profiles/ro-crate): check for the compacted JSON-LD format of the file descriptor
- feat(profiles/ro-crate): check recommended existence of absolute local data entities
- feat(profiles/ro-crate): update check to skip absolute paths
- feat(core): extend entity model to detect local and relative paths
- feat(profiles/ro-crate): check for the existence of data entities
- feat(cli): allow configuring the list of checks to skip via CLI
- feat(core): allow skipping a configurable list of checks
- feat(cli): display the full check identifier when verbose mode is enabled
- feat(core): fix and extend method to fetch entities by type
- feat(core): add utility method to retrieve all data entities
- feat(core): expose path/uri of rocrate entities
- feat(core): add class method to derive data entity path from identifier
- feat(cli): check the minimum required Python version
- feat(utils): add utility functions to read and check the minimum required Python version
- refactor(cli): remove CLI parameters from the global validation settings
- refactor(core): move the init logic to the
__post__init__method - refactor(profiles/ro-crate): move required properties to a dedicated shape
- refactor(core): declare the function as class level method
- refactor(core): simplify profiles parsing
- refactor(core): rewrite magic method to sort profiles
- refactor(cli): update the short option to skip checks
- refactor(core): use method to identify remote entities
- refactor(core): remove redundant code
- refactor(core): rename method arguments
- refactor(core): rename method
- refactor(core): remove redundant method
- refactor(core): remove cache timeout from validation settings
- refactor(core): remove unused
ontology_pathsetting - refactor(core): rename the flag to disable downloading a remote crate
- refactor(core): rename flag to disable reporting of inherited checks
- refactor(core): rename property to enable profile inheritance
- refactor(core): link the context with the settings as an object
- refactor(core): init and validate URI on settings object
- refactor(core): remove unused imports
- refactor(core): rename input parameter for the ro-crate uri
- refactor(core): remove internal settings from the
ValidationSettingsinterface
- fix(profiles/ro-crate): fix SHACL nodeKind constraint being too strict
- fix(cli): wrong param name
- fix(core): ensure skip_checks is defined before use
- fix(core): enable skipping of Python checks
- fix(core): enable skipping of SHACL checks
- fix(core): exclude skipped checks from stats
- fix(core): remove inherited checks from stats when
disable_inherited_profiles_issue_reportingis set - fix(cli): make the
disable_profile_inheritanceCLI flag affect only reporting - fix(profiles/ro-crate): trailing slash for Data Entities is recommended not mandatory
- docs(readthedocs): add copyright
- docs(readthedocs): mention the fallback profile
- docs(readthedocs): restructure toc
- docs(readthedocs): fix typos
- docs(readthedocs): rewrite note
- docs(readthedocs): reformat
- docs(readthedocs): update toc
- docs(readthedocs): rename api docs file
- docs(readthedocs): more details on profile detection and versioning
- docs(readthedocs): add an initial "How it works" section
- docs(readthedocs): add link to Github repository
- docs(readthedocs): dynamically set the version
- docs(readthedocs): fix copyright
- docs(diagrams): extend diagrams by adding captions
- docs(diagrams): fix svg width
- docs(diagrams): fix missing
by - docs(readthedocs): update flag description
- docs(core): don't expose an internal validate method
- docs(core): extend param description
- docs(diagrams): update diagrams
- docs(diagrams): fix missing link
- docs(diagrams): fix blanks
- docs(diagrams): add missing params
- docs: add diagram for the
profilesservice - docs: add diagram for the
validateservice - docs: fix link
- docs: move the diagram files
- docs: refine "Core Model" diagram
- docs(core): update docstring
- docs(core): add docstring of
ValidationSettingsclass - docs(readme): reformat note
- docs(readme): extend the list of features
- docs(core): improve code documentation
- docs(core): add docstrings to the
ValidationResultclass - docs(readme): add a comment on
profile_identifier - docs(readme): simplify path to crate in the programmatic validation example
- docs(readme): update list of supported profiles
- docs: add minimal example of programmatic usage
- docs: reformat
- docs(readme): extend example
- docs(core): add a docstring for the
violatingPropertyValue - docs(readme): add badge to the readthedocs documentation
- docs(core): bootstrap sphinx documentation
- perf(shacl): skip redundant violation messages
- perf(core): compute overrides on the fly
- perf(core): add a method to find a profile by checking its name
- perf(core): add properties to get parents and siblings of a given profile
- perf(core): add getter for sibling profiles
- perf(core): automatically detect overrides during Profile initialization
- perf(core): add support for overrides to the
Profilemodel
- feat(cli): swap default behaviour for fail fast
- feat(core): swap default behaviour
fail fastoption in API settings - feat: add provenance run crate profile
- feat(profiles/provenance-run-crate): check
connectionproperty onHowToStepinstances - feat(profiles/provenance-run-crate): check
connectionproperty on computational workflow instances - feat(profiles/provenance-run-crate): check if ParameterConnection instances are referenced through connections
- feat(core): add property to denote the format of the JSON output
- refactor(core): rename the property to indicate the validator version in the JSON output
- refactor(shacl): avoid code repetition
- refactor(core): reorder method args
- refactor(core): rename method arguments
- refactor(core): rename method
- refactor(core): remove redundant method
- refactor(core): remove cache timeout from validation settings
- refactor(core): remove unused
ontology_pathsetting - refactor(core): rename the flag to disable downloading a remote crate
- refactor(core): rename flag to disable reporting of inherited checks
- refactor(core): rename property to enable profile inheritance
- refactor(core): link the context with the settings as an object
- refactor(core): init and validate URI on settings object
- refactor(core): remove unused imports
- refactor(core): rename input parameter for the ro-crate uri
- refactor(core): remove internal settings from the
ValidationSettingsinterface - refactor(core): rename some properties of the
ValidationResultclass - refactor(services): the
profile_identifiershould be a positional argument - refactor(core): update the representation of the
ValidationResultobject - refactor(shacl): mark internal methods
- refactor(core): rename link property between result and RO-Crate URI
- refactor(core): rename some CheckIssue properties
- refactor(services): remove unused function argument
- refactor(core): rename the parameter for ROCrate instantiation
- refactor(core): use more descriptive names for
resultPathandfocusNode - refactor(core): update
CheckIssuerepresentation - refactor(core): improve the readability of the identifier
- refactor(core): add a docstring to the main validation classes
- refactor(cli): always include the
profile_identifiersproperty in the json output format - refactor(cli): move test data to the appropriate path
- refactor(profiles): move test data to the appropriate path
- refactor(profiles/provenance-run-crate): use validator prefixes to denote shapes
- fix(shacl): preserve issues with identical messages for different entities
- fix(profiles/provenance-run-crate): allow the position property of steps to accept integer values
- fix(readthedocs): minor changes
- fix(docs): raw html object to include the diagram
- fix(readthedocs): fix missing dependency
- fix(shacl): typo
- fix(core): typo
- fix(shacl): avoid repeating errors
- fix(core): fix severity detection of Python checks
- fix(core): determine the issue level and severity based on the check
- fix(profiles/workflow-run-crate): fix missing f-string formatting
- docs(profiles/provenance-run-crate): add copyright notice
- perf(core): compute overrides on the fly
- perf(core): add a method to find a profile by checking its name
- perf(core): add properties to get parents and siblings of a given profile
- perf(core): add getter for sibling profiles
- perf(core): automatically detect overrides during Profile initialization
- perf(core): add support for overrides to the
Profilemodel
- fix: RO-Crate validation should work for nested properties without id
- feat: allow to exit cli from pager on unix
- feat: allow to exit cli during interactive input on unix
- feat(core): add the ability to hide Python requirements
- feat(profile/ro-crate): validate ro-crate metadata is flattened
- feat(core): always validate the ROCrate URI before instantiating the corresponding object
- feat(utils): add function to validate a RO-Crate URI parameter
- refactor(utils): update the error message for resource unavailability
- refactor(cli): delegate URI validation from the CLI to the utility function
- refactor(utils): use the updated
ROCrateInvalidURIErrorclass - refactor(utils): set a default error message in the
ROCrateInvalidURIErrorclass
- fix(utils): fix string format of error message
- fix(core): allow to exit cli from pager on unix
- fix(core): allow to exit cli during interactive input on unix
- feat(cli): check the minimum required Python version
- feat(utils): add utility functions to read and check the minimum required Python version
- feat(profile/ro-crate): more comprehensive pattern to detect valid ISO 8601 dates
- feat(profile/ro-crate): add check for recommended values of the
RootDataEntitydatePublishedproperty - feat(shacl): add root requirement check
- feat(shacl): extend SHACL check initialisation
- feat(shacl): extend model to mark root requirement checks
- feat(core): extend model to include hidden requirement checks
- build(python): update the minimum python version to 3.9.20
- refactor(shacl): restructure the initialisation of shack checks
- refactor(shacl): restructure the logic to set and retrieve the requirement level in SHACL checks
- refactor(cli): update
profiles listto show the number of checks by severity - refactor(cli): restructure fn to generate checks stats
- refactor(core): update
get_requirementsmethod - refactor(core): remove
levelproperty from theRequirementmodel - refactor(core): update
Requirementidentifier - refactor(core): update the requirements loading process
- refactor(shacl): clean up
- fix(cli): skip counting overridden checks
- fix(cli): do not skip overridden checks when they belong to the target profile
- fix(shacl): fix property getter
- fix(profiles/ro-crate): fix severity of WebDataEntity shapes
- fix(shacl): fix the override of the base method
- fix(shacl): always parse the result graph
- fix(profiles/ro-crate): fix mismatch in the requirement level
- fix(core): fix LevelCollection getter
- fix(core): wrong property name
- fix(core): properly initialize
PyRequirementinstances - fix(shacl): use the shape description
- fix(shacl): fix condition to print the mismatch warning
- fix(core): fix in progress for detecting overrides
- fix(profiles/ro-crate): fix inconsistent severity level
- feat(core): add property to denote the format of the JSON output
- refactor(core): rename the property to indicate the validator version in the JSON output
- feat(core): add
to_dictserializer methods - feat(core): extend check info on JSON output
- feat(core): add minimal dict serializers for the Profile and RequirementCheck models
- refactor(core): add rocrate-validator version to the JSON output
- refactor(core): remove
rocratepath property from JSON output - refactor(core): remove
data_pathandprofiles_pathfrom JSON output - refactor(core): remove
resultPathfrom issue serialisation - refactor(shacl): expose
node_namegetter
- fix(core): fix severity detection of Python checks
- fix(core): determine the issue level and severity based on the check associated with the issue
- fix(profiles/workflow-run-crate): fix missing f-string formatting
- docs(profiles/workflow-run-crate): add copyright notice
- feat(profiles/provenance-run-crate): check
connectionproperty onHowToStepinstances - feat(profiles/provenance-run-crate): check
connectionproperty on computational workflow instances - feat(profiles/provenance-run-crate): check if ParameterConnection instances are referenced through connections
- feat(profiles/provenance-run-crate): add provenance run crate profile
- refactor(profiles/provenance-run-crate): use validator prefixes to denote shapes
- feat(core): declare package version
- feat(utils): enhance version detection: take Git repository state into account
- feat(profiles/workflow-run-crate): add workflow run crate profile
- build: rename package to
roc-validator - build: update package version number
- refactor(ci): restructure testing pipeline
- refactor(ci): restructure release pipeline
- refactor(core): use the
severityproperty to denote the severity level of a Python requirement - refactor(cli): remove short option for
profiles_path - refactor(profiles/ro-crate): move WebDataEntity shapes
- refactor(shacl): restructure the logic to set/get requirement level on SHACL checks
- refactor(core): update
Requirement.leveldefinition - refactor(core): update the requirements loading process
- refactor(shacl): set the conforms property to be computed based on the presence of issues
- refactor(core): fix the sorting criteria of the requirements
- refactor(core): safer way to add candidate profiles
- refactor(cli): fix output of
profiles describecommand - refactor(cli): disable ontologies parameter
- refactor(utils): generic function to load graphs from paths
- refactor: move code to the rocrate-validator folder
- refactor: move ttl file
- refactor: move code to the src folder
- fix(profiles/ro-crate): change severity of the
RootDataEntityproperties - fix(profiles/ro-crate): fix
sh:messagefor the requireddatePublished - fix(cli): disable pagination on Windows systems
- fix(logging): update logging configuration
- fix(shacl): report a generic error when the metadata is invalid
- fix(core): fix the sorting criteria of the requirements
- fix(profiles/ro-crate): fix inconsistent severity level
- fix(ci): update error message
- fix(ci): fix the command to check the tool version
- fix(ci): add missing steps
- docs(readme): add
pipas installation method - docs(readme): reorder status badges
- docs(readme): add PyPI version badge
- docs(readme): add build status badge
- docs(readme): update testing status and license badges
- docs: enrich the package metadata
- docs(readme): add installation instructions
- docs(readme): add usage instructions
- docs(readme): add supported profiles section
- docs(readme): add features section
- docs(readme): add badges
- perf(shacl): filter shapes based on the requirement level
- perf(shacl): set the check severity based on the declared value, or infer it from the path
- perf(shacl): allow to get declared
severityof a Shape Node
- fix: fix version parser
- feat(ci): restructure testing pipeline
- feat(ci): restructure release pipeline
- feat(core): allow to specify the
levelof a Python requirement - feat(shacl): filter shapes based on the requirement level
- feat(shacl): set the check severity based on the declared value, or infer it from the path
- feat(shacl): allow to get declared
severityof a Shape Node - feat(services): expose the severity property in the
get_profileservice - feat(shacl): enable info and warning severity levels in PySHACL
- feat(core): add
{severity,requirement_level}_from_pathproperties to theRequirementclass - feat(core): add properties to get parents and siblings of a given profile
- feat(core): add getter for sibling profiles
- feat(core): mark a requirement as overridden if all checks are overridden
- feat(core): do not notify events of overridden requirements
- feat(core): improve detection of check overrides
- feat(core): extend the check model to support multiple overrides
- feat(cli): support
profiles-pathoverride onprofilessubcommand - feat(cli): show multiple check overrides
- feat(cli): allow configuring the list of checks to skip via CLI
- build: rename package to
roc-validator - build: update package version number
- refactor(core): use the
severityproperty to denote the severity level of a Python requirement - refactor(cli): remove short option for
profiles_path - refactor(profiles/ro-crate): move WebDataEntity shapes
- refactor(shacl): restructure the logic to set/get requirement level on SHACL checks
- refactor(core): update
Requirement.leveldefinition - refactor(core): update the requirements loading process
- refactor(shacl): set the conforms property to be computed based on the presence of issues
- refactor(core): fix the sorting criteria of the requirements
- refactor(core): safer way to add candidate profiles
- refactor(cli): fix output of
profiles describecommand
- fix(shacl): fix property getter
- fix(profiles/ro-crate): fix severity of WebDataEntity shapes
- fix(shacl): fix the override of the base method
- fix(shacl): always parse the result graph
- fix(profiles/ro-crate): fix mismatch in the requirement level
- fix(core): fix LevelCollection getter
- fix(core): wrong property name
- fix(core): properly initialize
PyRequirementinstances - fix(shacl): use the shape description
- fix(shacl): fix condition to print the mismatch warning
- fix(core): fix in progress for detecting overrides
- fix(profiles/ro-crate): fix inconsistent severity level
- fix(shacl): report a generic error when the metadata is invalid
- docs(core): add package description
- docs(readme): update testing status and license badges
- perf(shacl): filter shapes based on the requirement level
- perf(shacl): set the check severity based on the declared value, or infer it from the path
- perf(shacl): allow to get declared
severityof a Shape Node
- feat(core): declare package version
- feat(utils): enhance version detection: take Git repository state into account
- feat(ci): set up automatic release process
- feat: add minimal cli entrypoint
- feat(srv): add validation services
- feat: add models
- feat: add utils module
- feat: initial minimal shapes
- build: configure the
rocrate-validatorscript - build(core): update Python packages
- build(dep): add click dependency
- build(dep): add pyshacl dependency
- build(dep): add rdflib dependency
- build: init poetry project
- refactor: move code to the rocrate-validator folder
- refactor: move ttl file
- refactor: move code to the src folder
- refactor(cli): disable ontologies parameter
- refactor(utils): generic function to load graphs from paths
- Initial release
- feat: add minimal cli entrypoint
- feat(srv): add validation services
- feat: add models
- feat: add utils module
- feat: initial minimal shapes
- build: configure the
rocrate-validatorscript - build(core): update Python packages
- build(dep): add click dependency
- build(dep): add pyshacl dependency
- build(dep): add rdflib dependency
- build: init poetry project
- refactor: move code to the rocrate-validator folder
- refactor: move ttl file
- refactor: move code to the src folder
- refactor(cli): disable ontologies parameter
- refactor(utils): generic function to load graphs from paths