rai-check-core 0.0.1__tar.gz

rai_check_core-0.0.1/.gitignore

@@ -0,0 +1,55 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Packaging / build
+build/
+dist/
+*.egg-info/
+*.egg
+pip-wheel-metadata/
+*.whl
+
+# Test / coverage / type checking
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+.hypothesis/
+
+# Audit runtime artifacts
+.rai-check/
+*_audit_report.html
+*_audit_report.md
+*_audit_report.json
+loan_audit_report.*
+
+# Environment / secrets
+.env
+.env.*
+!.env.example
+
+# IDE / editor
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+Desktop.ini
+
+# Typical dev data
+dev-data/

rai_check_core-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sai Teja Erukude
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rai_check_core-0.0.1/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.5
+Name: rai-check-core
+Version: 0.0.1
+Summary: Shared audit engine, findings, reports, and CLI for the RAI Check Kit
+Author: Sai Teja Erukude
+License: MIT License
+        
+        Copyright (c) 2026 Sai Teja Erukude
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: audit,fairness,responsible-ai,trustworthy-ai
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: jsonschema>=4.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.12
+Description-Content-Type: text/markdown
+
+# rai-check-core
+
+Shared audit findings, evidence manifests, history, and reporting APIs.
+
+Configured runs can include `standards-coverage` in `audit.report_formats` to
+write a standalone JSON evidence-coverage artifact. History exports are available
+from the CLI:
+
+```text
+rai-check export standards-coverage audit-run.json
+rai-check export history-dashboard --directory .rai-check/history
+rai-check export eu-post-market --directory .rai-check/history
+```
+
+Standards coverage and EU AI Act-oriented post-market reports summarize recorded
+evidence. They do not make a compliance claim.
+
+Configs, audit reports, evidence manifests, agent traces, and LLM suites use
+versioned JSON Schemas. Existing unversioned inputs are migrated to schema version
+`1.0` during loading.

rai_check_core-0.0.1/README.md

@@ -0,0 +1,20 @@
+# rai-check-core
+
+Shared audit findings, evidence manifests, history, and reporting APIs.
+
+Configured runs can include `standards-coverage` in `audit.report_formats` to
+write a standalone JSON evidence-coverage artifact. History exports are available
+from the CLI:
+
+```text
+rai-check export standards-coverage audit-run.json
+rai-check export history-dashboard --directory .rai-check/history
+rai-check export eu-post-market --directory .rai-check/history
+```
+
+Standards coverage and EU AI Act-oriented post-market reports summarize recorded
+evidence. They do not make a compliance claim.
+
+Configs, audit reports, evidence manifests, agent traces, and LLM suites use
+versioned JSON Schemas. Existing unversioned inputs are migrated to schema version
+`1.0` during loading.

rai_check_core-0.0.1/examples/ci-gate.yml

@@ -0,0 +1,94 @@
+# Example: RAI Check Gate in GitHub Actions
+#
+# Copy this file into your repository at .github/workflows/rai-check-gate.yml
+# and adjust the paths and thresholds to match your project.
+#
+# This workflow:
+#   1. Installs rai-check-ml
+#   2. Runs your audit script to produce an audit-run.json
+#   3. Calls `rai-check gate` — exits 1 (blocking deployment) on failure
+#   4. Exports a model card for the audit artifact
+#   5. Uploads the report as a workflow artifact
+
+name: RAI Check Gate
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  rai-check:
+    name: Responsible AI Audit
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install rai-check-ml
+        run: pip install rai-check-ml
+
+      # ── Run your audit script ───────────────────────────────────────────────
+      # Replace this step with your actual audit script.
+      # The script must produce a JSON file via report.to_json("audit-run.json").
+      #
+      # Minimal example (inline):
+      - name: Run audit
+        run: |
+          python - <<'EOF'
+          import numpy as np
+          import pandas as pd
+          from rai_audit.ml import ClassificationAudit
+
+          rng = np.random.default_rng(42)
+          n = 500
+          y_true = rng.integers(0, 2, n)
+          y_pred = y_true.copy()
+          # Inject synthetic bias: flip 30 % of predictions for group B
+          group = pd.DataFrame({"gender": rng.choice(["A", "B"], n)})
+          flip_mask = (group["gender"] == "B") & (rng.random(n) < 0.30)
+          y_pred[flip_mask] = 1 - y_pred[flip_mask]
+
+          report = ClassificationAudit(
+              y_true=y_true,
+              y_pred=y_pred,
+              sensitive_features=group,
+              project_name="Example Classifier",
+              persist=False,
+          ).run()
+          report.to_json("audit-run.json")
+          EOF
+
+      # ── Gate check ─────────────────────────────────────────────────────────
+      # Exit code 1 if any CRITICAL findings exist.
+      # Remove --fail-on-critical to allow critical findings through.
+      - name: RAI Check gate
+        run: |
+          rai-check gate audit-run.json \
+            --fail-on-critical \
+            --output-json gate-result.json
+
+      # ── Export model card (always, even on gate failure) ───────────────────
+      - name: Export model card
+        if: always()
+        run: |
+          rai-check export model-card audit-run.json \
+            --model-name "Example Classifier" \
+            --model-version "${{ github.sha }}" \
+            --output model-card.md
+
+      # ── Upload artifacts ───────────────────────────────────────────────────
+      - name: Upload audit artifacts
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: rai-check-report-${{ github.run_number }}
+          path: |
+            audit-run.json
+            gate-result.json
+            model-card.md
+          retention-days: 90

rai_check_core-0.0.1/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "rai-check-core"
+version = "0.0.1"
+description = "Shared audit engine, findings, reports, and CLI for the RAI Check Kit"
+readme = "README.md"
+license = { file = "LICENSE" }
+authors = [{ name = "Sai Teja Erukude" }]
+requires-python = ">=3.10"
+keywords = ["responsible-ai", "audit", "fairness", "trustworthy-ai"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+  "typer>=0.12",
+  "rich>=13.0",
+  "pyyaml>=6.0",
+  "jsonschema>=4.0",
+]
+
+[project.scripts]
+rai-check = "rai_audit.core.cli:app"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rai_audit"]
+
+[tool.hatch.build.targets.wheel.sources]
+"src" = ""

rai_check_core-0.0.1/src/rai_audit/core/__init__.py

@@ -0,0 +1,43 @@
+from rai_audit.core.evidence import build_evidence_manifest, load_evidence_manifest
+from rai_audit.core.findings import (
+    AuditFinding,
+    AuditReport,
+    CategoryRisk,
+    RemediationEffort,
+    RiskLevel,
+    Severity,
+)
+from rai_audit.core.history import build_history_summary, write_history_dashboard
+from rai_audit.core.monitoring import build_eu_ai_act_post_market_report
+from rai_audit.core.schemas import (
+    SCHEMA_VERSION,
+    SchemaDocumentError,
+    get_schema,
+    migrate_document,
+    prepare_document,
+    validate_document,
+)
+from rai_audit.core.scoring import compute_risk_matrix
+from rai_audit.core.standards import build_standards_coverage_report
+
+__all__ = [
+    "AuditFinding",
+    "AuditReport",
+    "CategoryRisk",
+    "RemediationEffort",
+    "RiskLevel",
+    "Severity",
+    "SCHEMA_VERSION",
+    "SchemaDocumentError",
+    "build_evidence_manifest",
+    "build_eu_ai_act_post_market_report",
+    "build_history_summary",
+    "build_standards_coverage_report",
+    "compute_risk_matrix",
+    "get_schema",
+    "load_evidence_manifest",
+    "migrate_document",
+    "prepare_document",
+    "validate_document",
+    "write_history_dashboard",
+]

rai_check_core-0.0.1/src/rai_audit/core/ci_formats.py

@@ -0,0 +1,114 @@
+from __future__ import annotations
+
+import json
+import xml.etree.ElementTree as ET
+from typing import Any
+
+from rai_audit.core.findings import AuditReport, Severity
+
+_SARIF_LEVEL = {
+    Severity.CRITICAL: "error",
+    Severity.HIGH: "error",
+    Severity.MEDIUM: "warning",
+    Severity.LOW: "note",
+}
+
+
+def render_sarif(report: AuditReport) -> str:
+    """Render active findings as SARIF 2.1.0 for CI and code-scanning systems."""
+    active = [
+        finding
+        for finding in report.findings
+        if finding.severity not in {Severity.PASSED, Severity.INFO}
+    ]
+    rules = {
+        finding.check_id: {
+            "id": finding.check_id,
+            "name": finding.title,
+            "shortDescription": {"text": finding.description},
+            "properties": {
+                "category": finding.category,
+                "standards_refs": finding.standards_refs,
+            },
+        }
+        for finding in active
+    }
+    results = [
+        {
+            "ruleId": finding.check_id,
+            "level": _SARIF_LEVEL.get(finding.severity, "note"),
+            "message": {"text": finding.description},
+            "properties": {
+                "category": finding.category,
+                "severity": finding.severity.value,
+                "evidence": finding.evidence,
+                "recommendation": finding.recommendation,
+                "standards_refs": finding.standards_refs,
+            },
+        }
+        for finding in active
+    ]
+    document: dict[str, Any] = {
+        "$schema": "https://json.schemastore.org/sarif-2.1.0.json",
+        "version": "2.1.0",
+        "runs": [
+            {
+                "tool": {
+                    "driver": {
+                        "name": "rai-check",
+                        "informationUri": "https://pypi.org/project/rai-check-kit/",
+                        "rules": list(rules.values()),
+                    }
+                },
+                "results": results,
+            }
+        ],
+    }
+    return json.dumps(document, indent=2)
+
+
+def render_junit(report: AuditReport) -> str:
+    """Render findings as JUnit XML for CI test-report systems."""
+    active = [
+        finding
+        for finding in report.findings
+        if finding.severity not in {Severity.PASSED, Severity.INFO}
+    ]
+    suite = ET.Element(
+        "testsuite",
+        {
+            "name": report.project_name,
+            "tests": str(len(report.findings)),
+            "failures": str(len(active)),
+        },
+    )
+    for finding in report.findings:
+        case = ET.SubElement(
+            suite,
+            "testcase",
+            {
+                "classname": finding.category or "General",
+                "name": finding.check_id,
+            },
+        )
+        if finding.severity not in {Severity.PASSED, Severity.INFO}:
+            failure = ET.SubElement(
+                case,
+                "failure",
+                {
+                    "message": finding.title,
+                    "type": finding.severity.value,
+                },
+            )
+            failure.text = finding.description
+        output = ET.SubElement(case, "system-out")
+        output.text = json.dumps(
+            {
+                "evidence": finding.evidence,
+                "recommendation": finding.recommendation,
+                "standards_refs": finding.standards_refs,
+            },
+            default=str,
+        )
+    ET.indent(suite)
+    return ET.tostring(suite, encoding="unicode")