API Reference

MAID Runner - Manifest-driven AI Development validation framework.

Library API for validating code artifacts against manifest specifications.

Quick start:

from maid_runner import validate, validate_all

# Validate a single manifest result = validate(“manifests/add-auth.manifest.yaml”) print(result.success) # True/False

# Validate all manifests in a directory batch = validate_all(“manifests/”) print(f”{batch.passed}/{batch.total_manifests} passed”)

Public Exports

__version__	str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
validate(manifest_path, *[, mode, ...])
validate_all([manifest_dir, mode, ...])
generate_snapshot(file_path, *[, ...])	Generate a snapshot manifest from an existing source file.
ValidationEngine([project_root, registry])
load_manifest(path)
save_manifest(manifest, path)
ManifestChain(manifest_dir[, project_root])
AcceptanceConfig([tests, immutable])
ArtifactKind(*values)
ArtifactSpec(kind, name[, description, ...])
ArgSpec(name[, type, default])
FileSpec(path, artifacts, status, mode, imports)
FileMode(*values)
DeleteSpec(path[, reason])
Manifest(slug, source_path, goal, ...[, ...])
TaskType(*values)
TestStream(*values)
ValidationMode(*values)
ValidationResult(success, manifest_slug, ...)
BatchValidationResult(results, ...)
ValidationError(code, message, severity, ...)
ErrorCode(*values)
Severity(*values)
Location(file[, line, column, end_line, ...])
FileTrackingReport(entries)
FileTrackingStatus(*values)
FileTrackingEntry(path, status[, manifests, ...])
TestRunResult(manifest_slug, command, ...)
BatchTestResult(results, total, passed, ...)
ValidatorRegistry()	Instance-scoped registry of language validators.
UnsupportedLanguageError(extension)	No validator available for a file extension.
BaseValidator()	Abstract base for language-specific code validators.
FoundArtifact(kind, name[, of, args, ...])	An artifact found by a language validator in source code.
CollectionResult(artifacts, language, file_path)	Result of collecting artifacts from a source file.
ManifestLoadError(path, reason)
ManifestSchemaError(path, errors)
KnowledgeGraph()	Container class for managing nodes and edges in a knowledge graph.
NodeType(*values)	Enumeration of graph node types.
EdgeType(*values)	Enumeration of graph edge types.
CoherenceEngine([checks])	Orchestrates coherence validation.
CoherenceResult([issues, checks_run, ...])	Complete result of coherence validation.