plan-doc 0.1.0__tar.gz

plan_doc-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 m0j0d
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

plan_doc-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: plan-doc
+Version: 0.1.0
+Summary: Typed parser for plan-file YAML frontmatter (schema v1) — strict validation, first-block-only extraction, foreign-document discrimination
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.3; extra == "dev"
+Dynamic: license-file
+
+# plan-doc
+
+Typed parser for plan-file YAML frontmatter (schema v1). Extracts the
+machine-readable fields a plan-driven-PR workflow needs — `template`,
+`disposal`, `branch`, a planner-handoff `dossier` block — from markdown
+plan documents, with strict validation and loud failures.
+
+```python
+from pathlib import Path
+from plan_doc import PlanDoc, PlanDocError, NonDraftPrFrontmatterError
+
+doc = PlanDoc.from_path(Path("docs/plans/my-plan.md"))
+if doc.disposal == "delete-on-merge":
+    ...
+if doc.dossier is not None:
+    files = doc.dossier.get("files", [])
+```
+
+## What it enforces
+
+- **Schema v1.** `plan_schema: 1` is required; `template`, `disposal`,
+  `phase`, `cleanup_trigger`, `ticket`, `branch`, `tdd_mode`, `dossier`
+  are the only other top-level keys. Unknown keys raise `PlanDocError` —
+  this is the typo guard (`dispozal` fails loud).
+- **First-block-only parsing.** Only a `---`...`---` block at the very
+  top of the file is frontmatter. Body-level `---` horizontal rules are
+  never split on.
+- **Foreign-document discrimination.** Valid frontmatter with no
+  `plan_schema` and no plan indicator fields raises the typed subclass
+  `NonDraftPrFrontmatterError`, so callers can treat non-plan documents
+  leniently without swallowing real validation errors.
+- **No frontmatter at all** raises `PlanDocError` with an actionable
+  message (add `plan_schema: 1`).
+
+## Dependency note
+
+`pyyaml` is a hard dependency, and the module *also* keeps a minimal
+no-yaml fallback parser (`_parse_yaml_minimal`) for simple `key: value`
+frontmatter. Both halves are deliberate: the upstream source of this
+module runs in a zero-pip environment and relies on the fallback, while
+the package declares full functionality. The fallback is covered by
+tests here — don't remove either half.
+
+## Provenance
+
+Extracted verbatim (code byte-identical, module docstring reframed) from
+the draft-pr skill of the m0j0d portfolio plugin, where the vendored copy
+remains the operational source of truth. This package mirrors it at
+release points.
+
+Pool purity rule: transport-free, LLM-agnostic, no secrets. Pure parsing;
+the only I/O is `Path.read_text` in `PlanDoc.from_path`.
+
+## License
+
+MIT

plan_doc-0.1.0/README.md

@@ -0,0 +1,56 @@
+# plan-doc
+
+Typed parser for plan-file YAML frontmatter (schema v1). Extracts the
+machine-readable fields a plan-driven-PR workflow needs — `template`,
+`disposal`, `branch`, a planner-handoff `dossier` block — from markdown
+plan documents, with strict validation and loud failures.
+
+```python
+from pathlib import Path
+from plan_doc import PlanDoc, PlanDocError, NonDraftPrFrontmatterError
+
+doc = PlanDoc.from_path(Path("docs/plans/my-plan.md"))
+if doc.disposal == "delete-on-merge":
+    ...
+if doc.dossier is not None:
+    files = doc.dossier.get("files", [])
+```
+
+## What it enforces
+
+- **Schema v1.** `plan_schema: 1` is required; `template`, `disposal`,
+  `phase`, `cleanup_trigger`, `ticket`, `branch`, `tdd_mode`, `dossier`
+  are the only other top-level keys. Unknown keys raise `PlanDocError` —
+  this is the typo guard (`dispozal` fails loud).
+- **First-block-only parsing.** Only a `---`...`---` block at the very
+  top of the file is frontmatter. Body-level `---` horizontal rules are
+  never split on.
+- **Foreign-document discrimination.** Valid frontmatter with no
+  `plan_schema` and no plan indicator fields raises the typed subclass
+  `NonDraftPrFrontmatterError`, so callers can treat non-plan documents
+  leniently without swallowing real validation errors.
+- **No frontmatter at all** raises `PlanDocError` with an actionable
+  message (add `plan_schema: 1`).
+
+## Dependency note
+
+`pyyaml` is a hard dependency, and the module *also* keeps a minimal
+no-yaml fallback parser (`_parse_yaml_minimal`) for simple `key: value`
+frontmatter. Both halves are deliberate: the upstream source of this
+module runs in a zero-pip environment and relies on the fallback, while
+the package declares full functionality. The fallback is covered by
+tests here — don't remove either half.
+
+## Provenance
+
+Extracted verbatim (code byte-identical, module docstring reframed) from
+the draft-pr skill of the m0j0d portfolio plugin, where the vendored copy
+remains the operational source of truth. This package mirrors it at
+release points.
+
+Pool purity rule: transport-free, LLM-agnostic, no secrets. Pure parsing;
+the only I/O is `Path.read_text` in `PlanDoc.from_path`.
+
+## License
+
+MIT

plan_doc-0.1.0/plan_doc.egg-info/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: plan-doc
+Version: 0.1.0
+Summary: Typed parser for plan-file YAML frontmatter (schema v1) — strict validation, first-block-only extraction, foreign-document discrimination
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=9.0.3; extra == "dev"
+Dynamic: license-file
+
+# plan-doc
+
+Typed parser for plan-file YAML frontmatter (schema v1). Extracts the
+machine-readable fields a plan-driven-PR workflow needs — `template`,
+`disposal`, `branch`, a planner-handoff `dossier` block — from markdown
+plan documents, with strict validation and loud failures.
+
+```python
+from pathlib import Path
+from plan_doc import PlanDoc, PlanDocError, NonDraftPrFrontmatterError
+
+doc = PlanDoc.from_path(Path("docs/plans/my-plan.md"))
+if doc.disposal == "delete-on-merge":
+    ...
+if doc.dossier is not None:
+    files = doc.dossier.get("files", [])
+```
+
+## What it enforces
+
+- **Schema v1.** `plan_schema: 1` is required; `template`, `disposal`,
+  `phase`, `cleanup_trigger`, `ticket`, `branch`, `tdd_mode`, `dossier`
+  are the only other top-level keys. Unknown keys raise `PlanDocError` —
+  this is the typo guard (`dispozal` fails loud).
+- **First-block-only parsing.** Only a `---`...`---` block at the very
+  top of the file is frontmatter. Body-level `---` horizontal rules are
+  never split on.
+- **Foreign-document discrimination.** Valid frontmatter with no
+  `plan_schema` and no plan indicator fields raises the typed subclass
+  `NonDraftPrFrontmatterError`, so callers can treat non-plan documents
+  leniently without swallowing real validation errors.
+- **No frontmatter at all** raises `PlanDocError` with an actionable
+  message (add `plan_schema: 1`).
+
+## Dependency note
+
+`pyyaml` is a hard dependency, and the module *also* keeps a minimal
+no-yaml fallback parser (`_parse_yaml_minimal`) for simple `key: value`
+frontmatter. Both halves are deliberate: the upstream source of this
+module runs in a zero-pip environment and relies on the fallback, while
+the package declares full functionality. The fallback is covered by
+tests here — don't remove either half.
+
+## Provenance
+
+Extracted verbatim (code byte-identical, module docstring reframed) from
+the draft-pr skill of the m0j0d portfolio plugin, where the vendored copy
+remains the operational source of truth. This package mirrors it at
+release points.
+
+Pool purity rule: transport-free, LLM-agnostic, no secrets. Pure parsing;
+the only I/O is `Path.read_text` in `PlanDoc.from_path`.
+
+## License
+
+MIT

plan_doc-0.1.0/plan_doc.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+plan_doc.py
+pyproject.toml
+plan_doc.egg-info/PKG-INFO
+plan_doc.egg-info/SOURCES.txt
+plan_doc.egg-info/dependency_links.txt
+plan_doc.egg-info/requires.txt
+plan_doc.egg-info/top_level.txt
+tests/test_plan_doc.py

plan_doc-0.1.0/plan_doc.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

plan_doc-0.1.0/plan_doc.egg-info/requires.txt

@@ -0,0 +1,4 @@
+pyyaml>=6.0
+
+[dev]
+pytest>=9.0.3

plan_doc-0.1.0/plan_doc.egg-info/top_level.txt

@@ -0,0 +1 @@
+plan_doc