orchestrata_ultimate.openspec

Reference › orchestrata_ultimate › openspec › init

Public facade of the OpenSpec support package (SPEC-104). It re-exports the entry points of detect, models, parse, render and repo. tests/openspec/test_openspec.py imports it.

At a glance

Class diagram

No classes; see Functions.

Dependency diagram

API

No public API: the module defines no classes, functions or constants.

Source

Permalink: https://gitlab.com/MSamy/orchestrata-ultimate-architecture/-/blob/a4cbc2bdf/src/orchestrata_ultimate/openspec/__init__.py

"""OpenSpec format support (SPEC-104).

Detect a project's spec folder, recognize the OpenSpec convention, and
parse / create / edit OpenSpec capability specs and change proposals.

    from orchestrata_ultimate.openspec import detect_spec_folder, OpenSpecRepo
    sf = detect_spec_folder(".")
    if sf.format == "openspec":
        repo = OpenSpecRepo(sf.root)
        doc = repo.read_capability(sf.capabilities[0])
"""

from orchestrata_ultimate.openspec.detect import detect_spec_folder, is_openspec
from orchestrata_ultimate.openspec.models import (
    Delta,
    OpenSpecDoc,
    Requirement,
    Scenario,
    SpecFolder,
)
from orchestrata_ultimate.openspec.parse import parse_deltas, parse_spec, validate
from orchestrata_ultimate.openspec.render import (
    render_delta,
    render_proposal,
    render_spec,
    render_tasks,
)
from orchestrata_ultimate.openspec.repo import OpenSpecError, OpenSpecRepo

__all__ = [
    "detect_spec_folder",
    "is_openspec",
    "parse_spec",
    "parse_deltas",
    "validate",
    "render_spec",
    "render_delta",
    "render_proposal",
    "render_tasks",
    "OpenSpecRepo",
    "OpenSpecError",
    "OpenSpecDoc",
    "Requirement",
    "Scenario",
    "Delta",
    "SpecFolder",
]