rocrate-validator
Getting Started
Installation
CLI Validation
Programmatic Validation
How It Works
Offline Mode and HTTP Caching
Resources
Validation Profiles
Writing a new profile
API documentation
Index
About
Acknowledgements
rocrate-validator
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
_
__eq__() (rocrate_validator.models.Requirement method)
__ge__() (rocrate_validator.models.Requirement method)
__gt__() (rocrate_validator.models.Requirement method)
__hash__() (rocrate_validator.models.Requirement method)
__init__() (rocrate_validator.models.Requirement method)
__le__() (rocrate_validator.models.Requirement method)
__lt__() (rocrate_validator.models.Requirement method)
__ne__() (rocrate_validator.models.Requirement method)
__repr__() (rocrate_validator.models.Requirement method)
__str__() (rocrate_validator.models.Requirement method)
__weakref__ (rocrate_validator.models.Requirement attribute)
A
abort_on_first (rocrate_validator.models.ValidationSettings attribute)
add_issue() (rocrate_validator.models.ValidationResult method)
all() (rocrate_validator.models.Profile class method)
allow_requirement_check_override (rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationSettings attribute)
B
BadSyntaxError
C
cache_max_age (rocrate_validator.models.ValidationSettings attribute)
cache_path (rocrate_validator.models.ValidationSettings attribute)
check (rocrate_validator.errors.CheckValidationError property)
(rocrate_validator.models.CheckIssue property)
check() (in module rocrate_validator.requirements.python)
check_name (rocrate_validator.errors.DuplicateRequirementCheck property)
CheckIssue (class in rocrate_validator.models)
CheckValidationError
code (rocrate_validator.errors.BadSyntaxError property)
(rocrate_validator.errors.ValidationError property)
comment (rocrate_validator.models.Profile property)
context (rocrate_validator.models.ValidationResult property)
D
data_graph (rocrate_validator.models.ValidationContext property)
descendants (rocrate_validator.models.Profile property)
description (rocrate_validator.models.Profile property)
disable_check_for_duplicates (rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationSettings attribute)
disable_inherited_profiles_issue_reporting (rocrate_validator.models.ValidationSettings attribute)
disable_remote_crate_download (rocrate_validator.models.ValidationSettings attribute)
DuplicateRequirementCheck
E
Event (class in rocrate_validator.events)
executed_checks (rocrate_validator.models.ValidationResult property)
extra_profiles_path (rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationSettings attribute)
F
fail_fast (rocrate_validator.models.ValidationContext property)
failed_checks (rocrate_validator.models.ValidationResult property)
failed_requirements (rocrate_validator.models.ValidationResult property)
find_in_list() (rocrate_validator.models.Profile class method)
from_metadata_dict() (rocrate_validator.models.ROCrate static method)
G
get_by_identifier() (rocrate_validator.models.Profile class method)
get_by_name() (rocrate_validator.models.Profile class method)
get_by_token() (rocrate_validator.models.Profile class method)
get_by_uri() (rocrate_validator.models.Profile class method)
get_data_graph() (rocrate_validator.models.ValidationContext method)
get_descendants() (rocrate_validator.models.Profile class method)
get_executed_check_result() (rocrate_validator.models.ValidationResult method)
get_external_file_content() (rocrate_validator.models.ROCrate static method)
get_external_file_size() (rocrate_validator.models.ROCrate static method)
get_failed_checks_by_requirement() (rocrate_validator.models.ValidationResult method)
get_failed_checks_by_requirement_and_severity() (rocrate_validator.models.ValidationResult method)
get_file_content() (rocrate_validator.models.ROCrate method)
get_file_size() (rocrate_validator.models.ROCrate method)
get_issues() (rocrate_validator.models.ValidationResult method)
get_issues_by_check() (rocrate_validator.models.ValidationResult method)
get_profile() (in module rocrate_validator.services)
get_profile_by_identifier() (rocrate_validator.models.ValidationContext method)
get_profile_by_token() (rocrate_validator.models.ValidationContext method)
get_profiles() (in module rocrate_validator.services)
get_requirement() (rocrate_validator.models.Profile method)
get_requirement_check() (rocrate_validator.models.Profile method)
get_requirements() (rocrate_validator.models.Profile method)
get_sibling_profiles() (rocrate_validator.models.Profile class method)
get_source_snippet() (rocrate_validator.models.RequirementCheck method)
H
has_descriptor() (rocrate_validator.models.ROCrate method)
has_directory() (rocrate_validator.models.ROCrate method)
has_file() (rocrate_validator.models.ROCrate method)
has_issues() (rocrate_validator.models.ValidationResult method)
I
identifier (rocrate_validator.models.Profile property)
(rocrate_validator.models.Requirement property)
inheritance_enabled (rocrate_validator.models.ValidationContext property)
InvalidProfilePath
InvalidSerializationFormat
is_profile_of (rocrate_validator.models.Profile property)
is_transitive_profile_of (rocrate_validator.models.Profile property)
issues (rocrate_validator.models.ValidationResult property)
L
level (rocrate_validator.models.CheckIssue property)
LevelCollection (class in rocrate_validator.models)
list_files (rocrate_validator.models.ROCrate property)
M
MAY (rocrate_validator.models.LevelCollection attribute)
maybe_warn_offline_cache_miss() (rocrate_validator.models.ValidationContext method)
message (rocrate_validator.errors.BadSyntaxError property)
(rocrate_validator.errors.ProfileNotFound property)
(rocrate_validator.errors.ProfileSpecificationError property)
(rocrate_validator.errors.ROCrateInvalidURIError property)
(rocrate_validator.errors.ROCrateMetadataNotFoundError property)
(rocrate_validator.errors.ValidationError property)
(rocrate_validator.models.CheckIssue property)
metadata (rocrate_validator.models.ROCrate property)
metadata_dict (rocrate_validator.models.ValidationSettings attribute)
metadata_only (rocrate_validator.models.ValidationSettings attribute)
module
rocrate_validator.errors
MUST (rocrate_validator.models.LevelCollection attribute)
MUST_NOT (rocrate_validator.models.LevelCollection attribute)
N
name (rocrate_validator.models.Profile property)
new_instance() (rocrate_validator.models.ROCrate static method)
no_cache (rocrate_validator.models.ValidationSettings attribute)
O
offline (rocrate_validator.models.ValidationSettings attribute)
OPTIONAL (rocrate_validator.models.LevelCollection attribute)
(rocrate_validator.models.Severity attribute)
order_number (rocrate_validator.models.Requirement property)
overridden_by (rocrate_validator.models.Profile property)
overrides (rocrate_validator.models.Profile property)
P
parents (rocrate_validator.models.Profile property)
parse() (rocrate_validator.models.ValidationSettings class method)
passed() (rocrate_validator.models.ValidationResult method)
path (rocrate_validator.errors.BadSyntaxError property)
(rocrate_validator.errors.ROCrateMetadataNotFoundError property)
(rocrate_validator.errors.ValidationError property)
(rocrate_validator.models.Profile property)
Profile (class in rocrate_validator.models)
profile_identifier (rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationSettings attribute)
profile_name (rocrate_validator.errors.DuplicateRequirementCheck property)
(rocrate_validator.errors.ProfileNotFound property)
profile_path (rocrate_validator.errors.InvalidProfilePath property)
profile_specification_file_path (rocrate_validator.models.Profile property)
profile_specification_graph (rocrate_validator.models.Profile property)
PROFILE_VALIDATION_END (rocrate_validator.events.EventType attribute)
PROFILE_VALIDATION_START (rocrate_validator.events.EventType attribute)
ProfileNotFound
profiles (rocrate_validator.models.ValidationContext property)
profiles_path (rocrate_validator.errors.ProfilesDirectoryNotFound property)
(rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationSettings attribute)
ProfilesDirectoryNotFound
ProfileSpecificationError
ProfileSpecificationNotFound
publicID (rocrate_validator.models.ValidationContext property)
PyRequirement (class in rocrate_validator.requirements.python)
R
readme_file_path (rocrate_validator.models.Profile property)
RECOMMENDED (rocrate_validator.models.LevelCollection attribute)
(rocrate_validator.models.Severity attribute)
rel_fd_path (rocrate_validator.models.ValidationContext property)
REQUIRED (rocrate_validator.models.LevelCollection attribute)
(rocrate_validator.models.Severity attribute)
Requirement (class in rocrate_validator.models)
requirement() (in module rocrate_validator.requirements.python)
REQUIREMENT_CHECK_VALIDATION_END (rocrate_validator.events.EventType attribute)
REQUIREMENT_CHECK_VALIDATION_START (rocrate_validator.events.EventType attribute)
requirement_severity (rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationSettings attribute)
requirement_severity_only (rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationSettings attribute)
REQUIREMENT_VALIDATION_END (rocrate_validator.events.EventType attribute)
REQUIREMENT_VALIDATION_START (rocrate_validator.events.EventType attribute)
RequirementCheck (class in rocrate_validator.models)
RequirementLevel (class in rocrate_validator.models)
requirements (rocrate_validator.models.Profile property)
result (rocrate_validator.models.ValidationContext property)
ro_crate (rocrate_validator.models.ValidationContext property)
ROCrate (class in rocrate_validator.models)
rocrate_relative_root_path (rocrate_validator.models.ValidationSettings attribute)
rocrate_uri (rocrate_validator.models.ValidationContext property)
(rocrate_validator.models.ValidationResult property)
(rocrate_validator.models.ValidationSettings property)
rocrate_validator.errors
module
ROCrateInvalidURIError
ROCrateMetadataNotFoundError
ROCValidatorError
S
serialization_format (rocrate_validator.errors.InvalidSerializationFormat property)
settings (rocrate_validator.models.ValidationContext property)
severity (rocrate_validator.models.CheckIssue property)
(rocrate_validator.models.Profile property)
SHALL (rocrate_validator.models.LevelCollection attribute)
SHALL_NOT (rocrate_validator.models.LevelCollection attribute)
SHOULD (rocrate_validator.models.LevelCollection attribute)
SHOULD_NOT (rocrate_validator.models.LevelCollection attribute)
siblings (rocrate_validator.models.Profile property)
size() (rocrate_validator.models.ROCrate method)
skip_checks (rocrate_validator.models.ValidationSettings attribute)
skipped_checks (rocrate_validator.models.ValidationResult property)
spec_file (rocrate_validator.errors.ProfileSpecificationNotFound property)
statistics (rocrate_validator.models.ValidationResult property)
Subscriber (class in rocrate_validator.events)
T
target_profile (rocrate_validator.models.ValidationContext property)
target_validation_profile (rocrate_validator.models.ValidationContext property)
to_dict() (rocrate_validator.models.ValidationResult method)
(rocrate_validator.models.ValidationSettings method)
to_json() (rocrate_validator.models.ValidationResult method)
token (rocrate_validator.models.Profile property)
U
update() (rocrate_validator.events.Subscriber method)
uri (rocrate_validator.errors.ROCrateInvalidURIError property)
(rocrate_validator.models.Profile property)
(rocrate_validator.models.ROCrate property)
uri_string (rocrate_validator.errors.ROCrateInvalidURIError property)
V
validate() (in module rocrate_validator.services)
VALIDATION_END (rocrate_validator.events.EventType attribute)
validation_settings (rocrate_validator.models.ValidationResult property)
VALIDATION_START (rocrate_validator.events.EventType attribute)
ValidationContext (class in rocrate_validator.models)
ValidationError
ValidationResult (class in rocrate_validator.models)
ValidationSettings (class in rocrate_validator.models)
validator (rocrate_validator.models.ValidationContext property)
verbose (rocrate_validator.models.ValidationSettings attribute)
version (rocrate_validator.models.Profile property)
violatingEntity (rocrate_validator.models.CheckIssue property)
violatingProperty (rocrate_validator.models.CheckIssue property)
violatingPropertyValue (rocrate_validator.models.CheckIssue property)