Skip to documentation content
On this page
  1. Import contract
  2. Catalog-first automation
  3. Compatibility boundary

Choose the public Python surface

Use the canonical telion import for new automation and inspect versioned catalogs before generating feature or runtime commands.

New scripts should import from telion. The telion_api package remains the compatibility surface for existing automation and exposes additional legacy aliases. Both public inventories are generated from the installed packages' __all__ declarations.

Import contract

from telion import FeatureCatalog, PhysicsCatalog, RuntimeCommandCatalog

runtime = RuntimeCommandCatalog({"schemaVersion": "1.0.0", "commands": []})
features = FeatureCatalog({"schemaVersion": "1.0.0", "categories": []})
physics = PhysicsCatalog({"schemaVersion": "2.0.0", "interfaces": []})

assert runtime.action_names() == []
assert features.category_names() == []
assert physics.interfaces() == []

The empty payload above verifies the forward-compatible wrapper without attaching to a running desktop session. A live model supplies the installed runtime, generic-feature, and physics declarations.

Note. Treat telion as a Python API, not an HTTP service. Runtime commands are structured model operations sent through an attached Telion session.

Catalog-first automation

CatalogUse
RuntimeCommandCatalogDiscover command categories, parameters, requirements, and response contracts
FeatureCatalogDiscover generic model categories, feature kinds, fields, defaults, and allowed values
PhysicsCatalogDiscover interfaces, fields, domain and boundary features, outputs, and certified capabilities

Generate automation from the active catalog instead of assuming a feature name or field exists. Preview and deprecated capabilities retain their declared availability status in the versioned tree.

Compatibility boundary

If an existing script imports a name that is present only in telion_api, keep that import explicit until the script is migrated. The documentation version selector never substitutes a symbol from another Telion release.