Skip to main content

Governed frontmatter, freshness tethers, and validate-only runtime gates for agent-facing Markdown

Reason this release was yanked:

Superseded by 0.4.10. Non-strict project.yaml, body-byte-mutating edits, destructive output/runtime surfaces (runtime pack recursively deletes its --out dir; parse --output can destroy its input). Upgrade: pip install -U frontmattering

Project description

Frontmattering

Frontmattering makes Markdown safer for agents.

It adds governed frontmatter, task routing, body/frontmatter freshness tethers, and a vendorable validate-only runtime gate so an agent can consume a compact brief without silently relying on stale documentation.

Install

python -m pip install frontmattering
frontmattering --version
frontmattering doctor

First-hour path

frontmattering init . scaffolds a starter router under docs/, and frontmattering new creates governed documents. This block runs verbatim in an empty directory (it is executed as a release gate in CI):

frontmattering init . --set-id MYDOCS --title "My docs"
frontmattering new docs/10_GUIDE.md --profile guide --title "My guide"
frontmattering tether update --add .
frontmattering validate .
frontmattering brief .

Already have Markdown under docs/? Add governance to a file you already have with promote (one file per call):

frontmattering promote docs/YOUR_GUIDE.md --profile guide --in-place

Promoting a file outside the selected corpus fails before the file is touched (FRONTMATTERING-AUTHORING-TARGET-OUTSIDE-CORPUS).

For strict freshness enforcement, set validation_profile: trust in .frontmattering/project.yaml, then re-run frontmattering validate . and frontmattering brief ..

Runtime gate

frontmattering runtime pack --out frontmattering-runtime.pyz
python frontmattering-runtime.pyz validate docs --format json

The runtime artifact is validate-only. It does not expose init, promote, new, index, tether update, or authoring surfaces.

License

Frontmattering is source-available. It is free for individual personal use within the scope of LICENSE.md. Professional, organizational, employer, client, CI/CD, hosted, managed-service, platform, consulting, or revenue-connected use is permitted for a 30-day evaluation period under LICENSE.md; continued use after the evaluation requires a paid commercial license.

Frontmattering is not open-source software under the Open Source Definition because professional and organizational use is restricted without a commercial license.

Runtime dependency status is recorded in THIRD_PARTY_NOTICES.md; project notices are recorded in NOTICE.

Claim boundary

A FRESH brief means the current body bytes and canonical trust-bearing frontmatter fields match their mechanical tether. It does not prove semantic summary correctness, human approval, external adoption, or production suitability.

A STALE or UNTETHERED summary must not be relied on without reading the body.

Publication status

This v0.4.7 package brings the validate-only runtime to kernel parity: it resolves its subject set through the same canonical corpus selection as the kernel, so a missing path or a target with no governed Markdown blocks (never a GO over zero paths) and corpus include/exclude is honored. It also hardens input handling — complex/unhashable YAML keys and malformed tether input yield typed findings rather than tracebacks — and doctor gates no longer rely on assert (which vanishes under python -O). No frontmatter-schema or canonical-model (v0.1.5) changes. Custom license text should still receive legal review before paid commercial sales.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frontmattering-0.4.7.tar.gz (449.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

frontmattering-0.4.7-py3-none-any.whl (416.1 kB view details)

Uploaded Python 3

File details

Details for the file frontmattering-0.4.7.tar.gz.

File metadata

  • Download URL: frontmattering-0.4.7.tar.gz
  • Upload date:
  • Size: 449.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for frontmattering-0.4.7.tar.gz
Algorithm Hash digest
SHA256 dbde8180b67ee4b3b883babfe11166e1af8307be282a79b8bba31a19c768fe55
MD5 1fc32ec77152242e66dd2f83fee7ff66
BLAKE2b-256 d90e67edde58080f31def7d01a4895836409d48c78fc63590348f59d816aeaea

See more details on using hashes here.

File details

Details for the file frontmattering-0.4.7-py3-none-any.whl.

File metadata

  • Download URL: frontmattering-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 416.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for frontmattering-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 0b6d608ce96a0e7c0b6677edce8726bfc5d561900010d41993bd525ff98ffa2a
MD5 c538e4dad206d67904769cb7746655d7
BLAKE2b-256 19646eec91f27a6cdbc46d56de02a0a3c0f603a35231034a3f85680afcc1a39c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page