Home

APICORE Python

APICORE Python is a typed parser and validator for APICORE 1.0, 2.0, and 2.1 configuration files. The published APICORE_Python package exposes the apicore Python library and supports JSON, YAML, and TOML input.

Documents without APICORE_version retain APICORE 2.0 semantics unless they contain fields or localized values that are specific to APICORE 2.1. This preserves legacy compatibility while allowing undeclared 2.1 documents to be recognized automatically.

Scope

• Decode APICORE JSON, YAML, and TOML documents.
• Validate version-specific fields and constraints.
• Return frozen, typed dataclass models.
• Preserve custom parameter fields in Parameter.extra.
• Provide repository-only CLI and GUI validation tools.

The library does not execute HTTP requests, polling operations, browser actions, or handler scripts. In particular, a run handler is data only and is never executed by this package.

Requirements

• Python 3.12 or newer
• APICORE 1.0, 2.0, or 2.1

Navigation

• Getting Started
• Python API
• Data Models
• Parsing and Validation
• Version Compatibility
• Repository Tools
• Errors and Troubleshooting

Related Projects

• APICORE
• APICORE-2 specification and schema
• APICORE Python repository
• PyPI package