fastpdlc 0.1.0__tar.gz

fastpdlc-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

fastpdlc-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with: { python-version: "${{ matrix.python }}" }
+      - run: pip install -e ".[dev]"
+      - name: Unit tests
+        run: pytest -q
+      - name: Dogfood — the quickstart example must validate
+        run: |
+          fastpdlc -C examples/quickstart build
+          git diff --exit-code examples/quickstart/build/ \
+            || { echo "::error::quickstart bundle is stale — run fastpdlc build"; exit 1; }
+          fastpdlc -C examples/quickstart validate

fastpdlc-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+# Publish FastPDLC to PyPI when a GitHub Release is published.
+#
+# Auth is PyPI Trusted Publishing (OIDC) — no API token is stored anywhere. This
+# needs a ONE-TIME setup on PyPI (see RELEASING.md): add a trusted publisher for
+# project `fastpdlc`, owner `tarvitave`, repo `fastpdlc`, workflow `publish.yml`,
+# environment `pypi`. After that, cutting a Release ships the version on the tag.
+#
+# workflow_dispatch is a manual fallback: `gh workflow run publish.yml -f version=X.Y.Z`
+# publishes the current main (its pyproject version must equal the input).
+name: publish
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to publish — must equal pyproject.toml (e.g. 0.1.0)"
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  pypi:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # mint the OIDC token PyPI Trusted Publishing verifies
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+
+      - name: Build sdist + wheel
+        run: |
+          python -m pip install --upgrade build
+          python -m build
+
+      - name: Requested version must match the package version
+        # A mismatch would publish a surprise version — fail loudly instead.
+        run: |
+          set -euo pipefail
+          if [ "${{ github.event_name }}" = "release" ]; then
+            want="${GITHUB_REF_NAME#v}"
+          else
+            want="${{ github.event.inputs.version }}"; want="${want#v}"
+          fi
+          pkg="$(ls dist/*.whl | sed -E 's/.*fastpdlc-([0-9][^-]*)-.*/\1/')"
+          echo "requested=$want  package=$pkg  (event=${{ github.event_name }})"
+          test "$want" = "$pkg" || { echo "::error::requested ($want) != package version ($pkg)"; exit 1; }
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

fastpdlc-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+.pytest_cache/
+.venv/

fastpdlc-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

fastpdlc-0.1.0/PKG-INFO

@@ -0,0 +1,199 @@
+Metadata-Version: 2.5
+Name: fastpdlc
+Version: 0.1.0
+Summary: Product-as-code as a validated graph — for any project.
+Project-URL: Homepage, https://github.com/tarvitave/fastpdlc
+Project-URL: Issues, https://github.com/tarvitave/fastpdlc/issues
+Author: tarvitave
+License-Expression: LGPL-3.0-or-later
+License-File: LICENSE
+Keywords: docs-as-code,pdlc,product-as-code,product-management,validation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# FastPDLC
+
+**Product-as-code as a validated graph — for any project.**
+
+Your product intent — the glossary, the constraints, the business rules, the
+features, the decisions — usually lives as hopeful markdown that quietly rots. FastPDLC
+turns it into **code**: you declare your typed artifacts in one config file, and it
+loads them, enforces the schema and the cross-references, compiles a JSON bundle your
+app or docs can render, and **fails CI when the committed bundle drifts**.
+
+It started as the product-as-code engine inside a payments platform and was extracted
+so any team can use it.
+
+```bash
+pip install fastpdlc
+```
+
+## Quickstart
+
+1. Describe your artifact types in `product.config.yaml`:
+
+   ```yaml
+   product_dir: product
+   output: build/product.generated.json
+   types:
+     - name: terms                 # a glossary
+       dir: terms
+       id_prefix: "TERM-"          # ids must be TERM-<slug> and match the filename
+       required: [id, term, definition]
+       fields: [term, definition, see_also]
+       references:
+         - field: see_also         # every see_also must resolve to another term
+           to: terms
+     - name: rules                 # the durable invariants
+       dir: rules
+       id_prefix: "BR-"
+       required: [id, title, statement]
+       fields: [title, statement]
+   ```
+
+2. Author artifacts as markdown-with-frontmatter under `product/`:
+
+   ```markdown
+   ---
+   id: TERM-payment
+   term: Payment
+   definition: An instruction to move money between two parties.
+   see_also: [TERM-ledger]
+   ---
+   The canonical unit of work in the system.
+   ```
+
+3. Build the bundle and gate it in CI:
+
+   ```bash
+   fastpdlc build       # -> build/product.generated.json  (commit it)
+   fastpdlc validate    # schema + graph + staleness; non-zero exit on errors
+   ```
+
+## What `validate` enforces
+
+Every finding carries a stable `PAC-NNN` code (an API — CI and dashboards match on the
+code, never the prose):
+
+| code | meaning |
+|---|---|
+| `PAC-001` | an artifact is missing a required field |
+| `PAC-010` | an id doesn't start with its type's `id_prefix` |
+| `PAC-011` | an id doesn't match its filename |
+| `PAC-012` | a duplicate id within a type |
+| `PAC-020` | a reference field doesn't resolve to a known artifact |
+| `PAC-030` | a field value isn't in the type's allowed set (`enums`) |
+| `PAC-060` | the committed generated bundle is missing or stale |
+
+## Config reference
+
+Each entry under `types`:
+
+- **`name`** — the collection name (and the key in the bundle).
+- **`dir`** — the subdirectory under `product_dir`.
+- **`id_prefix`** *(optional)* — required id prefix; with **`id_matches_filename`**
+  (default `true`), the id must equal the filename stem.
+- **`required`** — frontmatter fields that must be present and non-empty (`id` always is).
+- **`fields`** — the fields captured into the bundle.
+- **`enums`** — `field -> [allowed values]`.
+- **`references`** — `[{ field, to }]`: values of `field` must be the id of a `to` artifact.
+
+## Extending it — plugins
+
+Real projects need more than schema: cross-file checks ("does this `links.code` path
+exist?"), derived bundle fields (reverse edges, rollups), extra generated outputs (a
+runtime catalogue), and their own diagnostic codes. A **plugin** registers those without
+forking the engine — which is how a large project migrates onto FastPDLC with **no loss
+of functionality**:
+
+```python
+# product_hooks.py
+from fastpdlc import register
+
+def register(reg):
+    register("PAC-900", "links.code path does not exist on disk")
+
+    @reg.validator
+    def code_paths_exist(bundle, config, root, report):
+        for f in bundle["features"]:
+            for path in f.get("code") or []:
+                if not (root / path).exists():
+                    report.add("PAC-900", f"missing {path}", f["_file"])
+
+    @reg.bundle_transformer
+    def reverse_edges(bundle, config, root):
+        ...  # enrich the bundle in place
+
+    reg.extra_output("build/catalogue.json", render_catalogue)  # staleness-gated too
+```
+
+```bash
+fastpdlc -p product_hooks.py validate
+```
+
+## Start a new repo in one command
+
+Scaffold a ready-to-go product-as-code repo (config, example artifacts, and the CI
+gate) with the [copier](https://copier.readthedocs.io) template:
+
+```bash
+pipx run copier copy --trust gh:tarvitave/fastpdlc my-product-repo
+```
+
+`--trust` lets the template run `fastpdlc build` once so the new repo is valid on its
+first commit.
+
+## CI
+
+Use the reusable Action — it installs FastPDLC and runs the gate:
+
+```yaml
+# .github/workflows/product.yml
+name: product-as-code
+on: [pull_request, push]
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: tarvitave/fastpdlc@v0.1.0
+        with:
+          config: product.config.yaml     # optional (default)
+          plugin: product_hooks.py         # optional project checks
+```
+
+<details><summary>Prefer plain pip?</summary>
+
+```yaml
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+      - run: pip install fastpdlc
+      - run: fastpdlc validate
+```
+</details>
+
+## Used in production
+
+FastPDLC is the product-as-code engine of the **pharthing / KibiPay** payments
+platform (39 features, a concept catalogue, and a ~283 KB render bundle). pharthing's
+CI runs `fastpdlc validate` as its sole gate via a plugin that adds domain checks — a
+byte-identical parity test proves nothing was lost in the extraction. That's the
+plugin system above, doing real work.
+
+## Releasing
+
+Publishing to PyPI is automated via GitHub Releases + Trusted Publishing — see
+[RELEASING.md](RELEASING.md).
+
+## License
+
+LGPL-3.0-or-later (copyleft, but you can import it as a library without your project inheriting the licence). See [LICENSE](LICENSE).

fastpdlc-0.1.0/README.md

@@ -0,0 +1,177 @@
+# FastPDLC
+
+**Product-as-code as a validated graph — for any project.**
+
+Your product intent — the glossary, the constraints, the business rules, the
+features, the decisions — usually lives as hopeful markdown that quietly rots. FastPDLC
+turns it into **code**: you declare your typed artifacts in one config file, and it
+loads them, enforces the schema and the cross-references, compiles a JSON bundle your
+app or docs can render, and **fails CI when the committed bundle drifts**.
+
+It started as the product-as-code engine inside a payments platform and was extracted
+so any team can use it.
+
+```bash
+pip install fastpdlc
+```
+
+## Quickstart
+
+1. Describe your artifact types in `product.config.yaml`:
+
+   ```yaml
+   product_dir: product
+   output: build/product.generated.json
+   types:
+     - name: terms                 # a glossary
+       dir: terms
+       id_prefix: "TERM-"          # ids must be TERM-<slug> and match the filename
+       required: [id, term, definition]
+       fields: [term, definition, see_also]
+       references:
+         - field: see_also         # every see_also must resolve to another term
+           to: terms
+     - name: rules                 # the durable invariants
+       dir: rules
+       id_prefix: "BR-"
+       required: [id, title, statement]
+       fields: [title, statement]
+   ```
+
+2. Author artifacts as markdown-with-frontmatter under `product/`:
+
+   ```markdown
+   ---
+   id: TERM-payment
+   term: Payment
+   definition: An instruction to move money between two parties.
+   see_also: [TERM-ledger]
+   ---
+   The canonical unit of work in the system.
+   ```
+
+3. Build the bundle and gate it in CI:
+
+   ```bash
+   fastpdlc build       # -> build/product.generated.json  (commit it)
+   fastpdlc validate    # schema + graph + staleness; non-zero exit on errors
+   ```
+
+## What `validate` enforces
+
+Every finding carries a stable `PAC-NNN` code (an API — CI and dashboards match on the
+code, never the prose):
+
+| code | meaning |
+|---|---|
+| `PAC-001` | an artifact is missing a required field |
+| `PAC-010` | an id doesn't start with its type's `id_prefix` |
+| `PAC-011` | an id doesn't match its filename |
+| `PAC-012` | a duplicate id within a type |
+| `PAC-020` | a reference field doesn't resolve to a known artifact |
+| `PAC-030` | a field value isn't in the type's allowed set (`enums`) |
+| `PAC-060` | the committed generated bundle is missing or stale |
+
+## Config reference
+
+Each entry under `types`:
+
+- **`name`** — the collection name (and the key in the bundle).
+- **`dir`** — the subdirectory under `product_dir`.
+- **`id_prefix`** *(optional)* — required id prefix; with **`id_matches_filename`**
+  (default `true`), the id must equal the filename stem.
+- **`required`** — frontmatter fields that must be present and non-empty (`id` always is).
+- **`fields`** — the fields captured into the bundle.
+- **`enums`** — `field -> [allowed values]`.
+- **`references`** — `[{ field, to }]`: values of `field` must be the id of a `to` artifact.
+
+## Extending it — plugins
+
+Real projects need more than schema: cross-file checks ("does this `links.code` path
+exist?"), derived bundle fields (reverse edges, rollups), extra generated outputs (a
+runtime catalogue), and their own diagnostic codes. A **plugin** registers those without
+forking the engine — which is how a large project migrates onto FastPDLC with **no loss
+of functionality**:
+
+```python
+# product_hooks.py
+from fastpdlc import register
+
+def register(reg):
+    register("PAC-900", "links.code path does not exist on disk")
+
+    @reg.validator
+    def code_paths_exist(bundle, config, root, report):
+        for f in bundle["features"]:
+            for path in f.get("code") or []:
+                if not (root / path).exists():
+                    report.add("PAC-900", f"missing {path}", f["_file"])
+
+    @reg.bundle_transformer
+    def reverse_edges(bundle, config, root):
+        ...  # enrich the bundle in place
+
+    reg.extra_output("build/catalogue.json", render_catalogue)  # staleness-gated too
+```
+
+```bash
+fastpdlc -p product_hooks.py validate
+```
+
+## Start a new repo in one command
+
+Scaffold a ready-to-go product-as-code repo (config, example artifacts, and the CI
+gate) with the [copier](https://copier.readthedocs.io) template:
+
+```bash
+pipx run copier copy --trust gh:tarvitave/fastpdlc my-product-repo
+```
+
+`--trust` lets the template run `fastpdlc build` once so the new repo is valid on its
+first commit.
+
+## CI
+
+Use the reusable Action — it installs FastPDLC and runs the gate:
+
+```yaml
+# .github/workflows/product.yml
+name: product-as-code
+on: [pull_request, push]
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: tarvitave/fastpdlc@v0.1.0
+        with:
+          config: product.config.yaml     # optional (default)
+          plugin: product_hooks.py         # optional project checks
+```
+
+<details><summary>Prefer plain pip?</summary>
+
+```yaml
+      - uses: actions/setup-python@v5
+        with: { python-version: "3.12" }
+      - run: pip install fastpdlc
+      - run: fastpdlc validate
+```
+</details>
+
+## Used in production
+
+FastPDLC is the product-as-code engine of the **pharthing / KibiPay** payments
+platform (39 features, a concept catalogue, and a ~283 KB render bundle). pharthing's
+CI runs `fastpdlc validate` as its sole gate via a plugin that adds domain checks — a
+byte-identical parity test proves nothing was lost in the extraction. That's the
+plugin system above, doing real work.
+
+## Releasing
+
+Publishing to PyPI is automated via GitHub Releases + Trusted Publishing — see
+[RELEASING.md](RELEASING.md).
+
+## License
+
+LGPL-3.0-or-later (copyleft, but you can import it as a library without your project inheriting the licence). See [LICENSE](LICENSE).

fastpdlc-0.1.0/RELEASING.md

@@ -0,0 +1,44 @@
+# Releasing FastPDLC
+
+Publishing is automated: `.github/workflows/publish.yml` builds and uploads to PyPI
+when a GitHub Release is published. Auth is **PyPI Trusted Publishing (OIDC)** — no
+API token is stored in the repo or in Actions secrets.
+
+## One-time PyPI setup
+
+Do this once, before the first release. It's the only manual step.
+
+1. Log in at <https://pypi.org>.
+2. Reserve the project name by creating a **pending publisher** (no upload needed
+   first): go to <https://pypi.org/manage/account/publishing/> → *Add a pending
+   publisher* and fill in:
+   - **PyPI project name:** `fastpdlc`
+   - **Owner:** `tarvitave`
+   - **Repository name:** `fastpdlc`
+   - **Workflow name:** `publish.yml`
+   - **Environment name:** `pypi`
+3. (Recommended) In the GitHub repo, create an **Environment** named `pypi`
+   (Settings → Environments) so the publish job's `environment: pypi` resolves and
+   you can add release protection rules later.
+
+That's it — no `PYPI_API_TOKEN`, no `twine` credentials.
+
+## Cutting a release
+
+1. Bump `version` in `pyproject.toml` (and note changes).
+2. Commit, tag, and push:
+   ```bash
+   git commit -am "release: vX.Y.Z"
+   git tag vX.Y.Z
+   git push --follow-tags
+   ```
+3. Publish a **GitHub Release** from that tag (`gh release create vX.Y.Z --generate-notes`).
+   That fires `publish.yml`, which asserts the tag matches `pyproject.toml`'s version,
+   builds the sdist + wheel, and uploads to PyPI via OIDC.
+4. Verify: `pip install fastpdlc==X.Y.Z`.
+
+## Versioning
+
+FastPDLC follows semver. Diagnostic **codes are API** — never renumber an existing
+`PAC-NNN` (retire and add). Changing the JSON bundle shape, a config key, or the
+plugin `Registry` surface is a breaking change → bump the major.