Python Compliance API¶

Security controls inspection and compliance report generation.

Available Controls (Community)¶

from oxideshield import available_controls, controls_by_component

# List all security controls
controls = available_controls()
for control in controls:
    print(f"{control.id}: {control.name} ({control.component})")
    print(f"  {control.description}")
    print(f"  Enabled: {control.enabled}")

# Filter by component
guard_controls = controls_by_component("guard")
scanner_controls = controls_by_component("scanner")

SecurityControl¶

Property	Type	Description
`id`	str	Unique control identifier
`name`	str	Human-readable name
`description`	str	Control description
`component`	str	Component name (guard, scanner, etc.)
`enabled`	bool	Whether control is active

Compliance Reports (Professional)¶

Professional License Required

compliance_report() requires a Professional or Enterprise license.

from oxideshield import compliance_report

# Create report builder
builder = compliance_report("My AI System")

# Add frameworks
builder = builder.with_framework("eu_ai_act")
builder = builder.with_framework("nist_ai_rmf")
# Or add all frameworks at once:
# builder = builder.with_all_frameworks()

# Add guards being used
builder = builder.with_guards(["pattern", "pii", "toxicity", "authoritarian"])

# Generate report
report = builder.generate()

# Export formats
print(report.to_json())
print(report.to_markdown())
print(report.to_html())

Supported Frameworks¶

Framework	Description
`eu_ai_act`	EU AI Act compliance mapping
`nist_ai_rmf`	NIST AI Risk Management Framework

ComplianceStatus¶

Status	Description
`Compliant`	Requirement fully met
`Partial`	Requirement partially met
`NeedsAttention`	Action required
`NotApplicable`	Not relevant to this deployment

Function Reference¶

Function	License	Description
`available_controls()`	Community	List all security controls
`controls_by_component(component)`	Community	Filter controls by component
`compliance_report(system_name)`	Professional	Create compliance report builder