theoworks-core 0.1.0

TheoWorks core — byte-stable sphinx-needs round-trip, schema, validation, and traceability (pure-Python, no runtime dependencies)

theoworks-core

Core library for TheoWorks — a byte-stable, round-trip toolkit for sphinx-needs requirements projects.

theoworks-core is pure Python with no runtime dependencies. It provides:

• Byte-stable RST round-trip — parse and re-serialize .. <type>:: need directives (and surrounding prose) with minimal, clean diffs.
• Schema model — load a project's need types, fields, and links from conf.py, a pack manifest, or observed usage.
• Validation — check needs against the resolved schema and summarize findings (errors / warnings).
• Traceability — compute link coverage and gaps across a needs graph.
• Packs — starter project templates (default, blank, aspice, vmodel) used to scaffold a new project.

Install

pip install theoworks-core

Usage

from theoworks_core import parse_document, serialize_document

doc = parse_document(open("docs/index.rst", encoding="utf-8").read())
for block in doc.blocks:
    print(block)

# Round-trips byte-for-byte:
assert serialize_document(doc) == open("docs/index.rst", encoding="utf-8").read()

Scaffold a new project:

from theoworks_core import scaffold_project

scaffold_project("my-project", name="My Project", pack="aspice")

Related packages

• theoworks-sphinx — the Sphinx extension that emits the needs graph (needs.json).
• theoworks-cli — the theoworks command-line interface.

License

Apache-2.0. See LICENSE.