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. Destructive surfaces remain: runtime pack recursively deletes an existing --out dir and 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.8 package closes trust-boundary defects in configuration and mutation: .frontmattering/project.yaml now rejects duplicate/non-scalar keys and invalid UTF-8 (a project can no longer display validation_profile: trust while a duplicate key silently selects default); tether update preserves the exact body bytes it protects (including CRLF); and brief / tether check exit codes track the trust verdict (a VIOLATED brief exits nonzero). 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.8.tar.gz (451.9 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.8-py3-none-any.whl (417.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frontmattering-0.4.8.tar.gz
  • Upload date:
  • Size: 451.9 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.8.tar.gz
Algorithm Hash digest
SHA256 4721f884816a1033401ba0ec02a6681a43f3263fb62f12c187463046e2a9fea8
MD5 2d5c8b3a145ecd1627bedfc9a31381ed
BLAKE2b-256 2dc4ecb76bec88c846af45418cc05502b78b6aca0fe209198eb30e427ac7ebc9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frontmattering-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 417.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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 bc24476f4d158471eba983c4da0a7e8057748b83904be21e947eb796884bd685
MD5 79fb8dfe6cfcdd0c2957b8014c4196ac
BLAKE2b-256 bc557963a2d3b79d57b3313b4b96fa97275599bb2d76275881afc4d7f4ede9f7

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