theoworks-sphinx-build 0.1.0__tar.gz

theoworks_sphinx_build-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 TheoWorks
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

theoworks_sphinx_build-0.1.0/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: theoworks-sphinx-build
+Version: 0.1.0
+Summary: The minimum TheoWorks Sphinx extension for a customer's own sphinx-build: emits theoworks-schema.json and (optionally) the diagram-image + computed-directive-result manifests, with zero crown-jewel IP
+Author: TheoWorks
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://theoworks.io
+Project-URL: Source, https://gitlab.com/theoworks/theoworks
+Keywords: sphinx,sphinx-needs,requirements,ASPICE,traceability
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: extension
+Requires-Dist: sphinx>=7.4; extra == "extension"
+Requires-Dist: sphinx-needs>=8.1.1; extra == "extension"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: sphinx>=7.4; extra == "dev"
+Requires-Dist: sphinx-needs>=8.1.1; extra == "dev"
+Requires-Dist: PyYAML; extra == "dev"
+Dynamic: license-file
+
+# theoworks-sphinx-build
+
+The **minimum** [TheoWorks](https://theoworks.io) Sphinx extension for a
+customer's own `sphinx-build`. It runs inside a
+[sphinx-needs](https://sphinx-needs.readthedocs.io) build and emits exactly
+the artifacts that genuinely require an in-build render:
+
+- `theoworks-schema.json` — the RESOLVED `needs_*` metamodel, captured after
+ every extension's `setup()` has run (so an extension-registered metamodel,
+ e.g. a bundle bringing its own `needs_types`, is recoverable even though it
+ never appears as a `conf.py` literal).
+- `theoworks-directive-images.json` — the needuml/needsequence
+ diagram-image location manifest (only when PlantUML rendered one).
+- `theoworks-directive-results.json` — the computed needtable/needlist/
+ needextract/needbar/needpie result manifest (only when a computed
+ directive occurs).
+
+This is deliberately **not** the full TheoWorks toolchain. `theoworks
+init` / `validate` / `trace` / `build-index`, the rich needs-graph read
+model, and the byte-stable RST editor all live in the proprietary
+`theoworks-cli` image / self-host server / VS Code extension — never in this
+package. `theoworks-sphinx-build` ships zero of that surface; its only
+dependency on TheoWorks IP is a small, vendored directive-block scanner +
+two content-address hashes (never the byte-stable serializer, validation, or
+packs).
+
+## Install
+
+```bash
+pip install theoworks-sphinx-build
+```
+
+## Usage
+
+Add the extension to your project's `conf.py` (after `sphinx_needs`) — note
+the **importable module name stays `theoworks_sphinx`**, even though the
+PyPI distribution is `theoworks-sphinx-build` (so an existing
+`extensions = [..., "theoworks_sphinx"]`, including anything TheoWorks has
+already scaffolded for you, keeps working unchanged):
+
+```python
+extensions = ["sphinx_needs", "theoworks_sphinx"]
+```
+
+Then build as usual:
+
+```bash
+sphinx-build -b html docs public
+```
+
+If the package is not installed, a TheoWorks-scaffolded `conf.py` degrades
+gracefully — the build still succeeds and still produces `needs.json` (the
+floor); you only lose the richer previews above.

theoworks_sphinx_build-0.1.0/README.md

@@ -0,0 +1,53 @@
+# theoworks-sphinx-build
+
+The **minimum** [TheoWorks](https://theoworks.io) Sphinx extension for a
+customer's own `sphinx-build`. It runs inside a
+[sphinx-needs](https://sphinx-needs.readthedocs.io) build and emits exactly
+the artifacts that genuinely require an in-build render:
+
+- `theoworks-schema.json` — the RESOLVED `needs_*` metamodel, captured after
+ every extension's `setup()` has run (so an extension-registered metamodel,
+ e.g. a bundle bringing its own `needs_types`, is recoverable even though it
+ never appears as a `conf.py` literal).
+- `theoworks-directive-images.json` — the needuml/needsequence
+ diagram-image location manifest (only when PlantUML rendered one).
+- `theoworks-directive-results.json` — the computed needtable/needlist/
+ needextract/needbar/needpie result manifest (only when a computed
+ directive occurs).
+
+This is deliberately **not** the full TheoWorks toolchain. `theoworks
+init` / `validate` / `trace` / `build-index`, the rich needs-graph read
+model, and the byte-stable RST editor all live in the proprietary
+`theoworks-cli` image / self-host server / VS Code extension — never in this
+package. `theoworks-sphinx-build` ships zero of that surface; its only
+dependency on TheoWorks IP is a small, vendored directive-block scanner +
+two content-address hashes (never the byte-stable serializer, validation, or
+packs).
+
+## Install
+
+```bash
+pip install theoworks-sphinx-build
+```
+
+## Usage
+
+Add the extension to your project's `conf.py` (after `sphinx_needs`) — note
+the **importable module name stays `theoworks_sphinx`**, even though the
+PyPI distribution is `theoworks-sphinx-build` (so an existing
+`extensions = [..., "theoworks_sphinx"]`, including anything TheoWorks has
+already scaffolded for you, keeps working unchanged):
+
+```python
+extensions = ["sphinx_needs", "theoworks_sphinx"]
+```
+
+Then build as usual:
+
+```bash
+sphinx-build -b html docs public
+```
+
+If the package is not installed, a TheoWorks-scaffolded `conf.py` degrades
+gracefully — the build still succeeds and still produces `needs.json` (the
+floor); you only lose the richer previews above.

theoworks_sphinx_build-0.1.0/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "theoworks-sphinx-build"
+version = "0.1.0"
+description = "The minimum TheoWorks Sphinx extension for a customer's own sphinx-build: emits theoworks-schema.json and (optionally) the diagram-image + computed-directive-result manifests, with zero crown-jewel IP"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "TheoWorks" }]
+keywords = ["sphinx", "sphinx-needs", "requirements", "ASPICE", "traceability"]
+# Deliberately []: this package never depends on theoworks-core (or any other
+# TheoWorks package). Its bounded "classify subset" (directive-block scan +
+# content-hash) is a VENDORED copy inside theoworks_sphinx._classify, not an
+# import — §4.2. sphinx/sphinx-needs are the customer's own build's
+# dependency, not this package's (see the `extension` extra below) — mirrors
+# how the (now-unpublished) theoworks-sphinx package always treated them.
+dependencies = []
+classifiers = [
+ "Development Status :: 4 - Beta",
+ "Framework :: Sphinx",
+ "Framework :: Sphinx :: Extension",
+ "Intended Audience :: Developers",
+ "Operating System :: OS Independent",
+ "Programming Language :: Python :: 3",
+ "Programming Language :: Python :: 3.10",
+ "Programming Language :: Python :: 3.11",
+ "Programming Language :: Python :: 3.12",
+ "Programming Language :: Python :: 3.13",
+ "Programming Language :: Python :: 3.14",
+ "Topic :: Documentation :: Sphinx",
+ "Topic :: Software Development :: Documentation",
+]
+
+[project.urls]
+Homepage = "https://theoworks.io"
+Source = "https://gitlab.com/theoworks/theoworks"
+
+[project.optional-dependencies]
+# Mirrors theoworks-sphinx's own `[extension]` extra (same reasoning: Sphinx
+# itself must be running for an extension to load at all, and extension.py
+# imports neither sphinx nor sphinx_needs at module level, so this package
+# stays importable/testable without either installed). A customer's own
+# sphinx-build already supplies both; this extra exists for anyone installing
+# theoworks-sphinx-build standalone (e.g. to run a real build locally) who
+# wants pip to pull a floor-conforming pair in the same resolution.
+#
+# sphinx-needs support floor >=8.1.1 — the same floor the scaffold's generated CI declares.
+extension = ["sphinx>=7.4", "sphinx-needs>=8.1.1"]
+dev = ["pytest>=8", "sphinx>=7.4", "sphinx-needs>=8.1.1", "PyYAML"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+markers = [
+ "slow: real Sphinx build; slower than pure unit tests",
+]

theoworks_sphinx_build-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

theoworks_sphinx_build-0.1.0/src/theoworks_sphinx/__init__.py

@@ -0,0 +1,32 @@
+"""``theoworks-sphinx-build`` — the ONE minimum TheoWorks PyPI package (ADR-0281).
+
+Distributed on PyPI as ``theoworks-sphinx-build``; the **importable module
+stays named** ``theoworks_sphinx`` (ADR-0281 §3) so an existing
+``extensions = [..., "theoworks_sphinx"]`` — including every project
+TheoWorks has already scaffolded — keeps working unchanged. Only the
+distribution name and its contents differ from the (now proprietary,
+unpublished) full ``theoworks-sphinx`` package: this one registers ONLY the
+three render-bound, core-free-of-crown-jewel hooks (schema dump + the two
+directive manifests, ADR-0281 §4) — never the rich extractor, never the
+byte-stable serializer/validation/packs.
+"""
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+from .directive_images import MANIFEST_NAME as DIRECTIVE_IMAGES_MANIFEST_NAME
+from .directive_results import MANIFEST_NAME as DIRECTIVE_RESULTS_MANIFEST_NAME
+from .schema_dump import SCHEMA_DUMP_NAME, build_dump, write_dump
+
+__all__ = [
+    "SCHEMA_DUMP_NAME", "build_dump", "write_dump",
+    "DIRECTIVE_IMAGES_MANIFEST_NAME", "DIRECTIVE_RESULTS_MANIFEST_NAME",
+    "setup",
+]
+
+
+def setup(app):
+    """Sphinx entry point (re-exported from .extension)."""
+    from .extension import setup as _setup
+
+    return _setup(app)

theoworks_sphinx_build-0.1.0/src/theoworks_sphinx/_classify/__init__.py

@@ -0,0 +1,53 @@
+"""The bounded, low-IP "classify subset" (ADR-0281 §4.1/§4.2 Option B).
+
+**What this is.** ``needs.py`` / ``prose.py`` / ``directives.py`` in this
+subpackage are **byte-identical vendored copies** of the same-named modules in
+``packages/theoworks-core/src/theoworks_core/`` — a directive-block scanner
+(``iter_need_blocks``/``parse_need``) plus two content-address hashes
+(``directive_image_key``/``directive_result_key``/``directive_structure``).
+Vendored, not imported, **on purpose**: importing ``theoworks_core`` (even a
+single submodule) executes ``theoworks_core/__init__.py``, which eagerly
+imports every module in the package — including the byte-stable RST
+round-trip serializer (ADR-0035), ``validate.py``, ``pack.py``, and
+``trace.py`` (the crown jewel). A customer who ``pip install``s
+``theoworks-sphinx-build`` must never receive that surface, so this
+subpackage is entirely self-contained: it imports nothing from
+``theoworks_core`` and nothing from ``theoworks_sphinx``'s own rich sibling
+package. See ``theoworks_sphinx_build`` test suite's IP-boundary test for the
+enforcement.
+
+**Why vendored copies instead of a re-export.** ``directives.py`` imports only
+``.needs`` and ``.prose`` (confirmed by reading their import lines — both are
+stdlib-only, `re`/`dataclasses`). That subgraph is genuinely separable from
+the rest of ``theoworks_core``, but Python has no way to import "only these
+three submodules" of a package without first running that package's
+``__init__.py``. Vendoring the three files verbatim is the only mechanism
+that ships a wheel provably free of the crown jewel while staying byte-exact
+with the editor client's own parse (the key correctness property ADR-0072 /
+ADR-0209 depend on: the manifest's key must match what
+``theoworks-ui-editor`` computes for the same directive content).
+
+**Anti-drift protection.** Because this is a physical copy rather than a
+single source of truth, ``tests/test_classify_vendored.drift_test.py`` in
+this package asserts the three files remain byte-identical to their
+``theoworks_core`` originals (a monorepo-only check — the drift guard reads
+the sibling package's source tree directly; it is a source-shape assertion,
+not a behavioral one). The REAL behavioral coverage — that the keys these
+functions produce match what the editor computes, and that the manifests
+this subset drives are correct — lives in
+``theoworks_sphinx_build``'s own real-``sphinx-build`` integration test and
+in ``theoworks-ui-editor``'s own directive-key parity tests; this drift guard
+only prevents the vendored copy from silently diverging from its source.
+"""
+from __future__ import annotations
+
+from .directives import directive_image_key, directive_result_key, directive_structure
+from .needs import iter_need_blocks, parse_need
+
+__all__ = [
+    "iter_need_blocks",
+    "parse_need",
+    "directive_structure",
+    "directive_image_key",
+    "directive_result_key",
+]