compliance_checker
Compliance Checker
Main pipecheck_compliance
Install
$
npx mthds install https://github.com/pipelex/methods --method compliance_checkerRun
$
npx mthds run method compliance_checkerCompliance Checker
Check a document against a set of compliance rules and produce a pass/fail assessment for each rule with evidence and remediation.
What it does
Given a document and a set of rules (Rule[]), this method:
- Extracts the document content into readable pages
- Checks each rule individually via batch processing, producing a
ComplianceResultwith status (pass/fail/partial/not_applicable), evidence, remediation suggestion, and severity
Concepts
- Rule: A compliance rule with
rule_id,rule_text,severity, andcategory - ComplianceResult: Assessment result with
status,evidence,remediation, andseverity
Exports
compliance_checking
check_compliancecheck_all_rulescheck_single_rule
Method Flowchart
Loading diagram…
Bundle Files
Select a file to view its contents
METHODS.toml
METHODS.toml
[package]
name = "compliance_checker"
display_name = "Compliance Checker"
address = "github.com/pipelex/methods"
version = "0.1.2"
description = "# Compliance Checker\n\nCheck a document against a set of compliance rules and produce a pass/fail assessment for each rule with evidence and remediation.\n\n## What it does\n\nGiven a **document** and a set of **rules** (`Rule[]`), this method:\n\n1. **Extracts** the document content into readable pages\n2. **Checks each rule** individually via batch processing, producing a `ComplianceResult` with status (pass/fail/partial/not_applicable), evidence, remediation suggestion, and severity\n\n## Concepts\n\n- **Rule**: A compliance rule with `rule_id`, `rule_text`, `severity`, and `category`\n- **ComplianceResult**: Assessment result with `status`, `evidence`, `remediation`, and `severity`"
license = "MIT"
authors = ["Evotis S.A.S"]
main_pipe = "check_compliance"
[exports.compliance_checking]
pipes = ["check_compliance", "check_all_rules", "check_single_rule"]