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. Runtime GO over zero paths, non-strict project.yaml, body-byte-mutating edits, and destructive output/runtime surfaces (runtime pack deletes its --out dir). 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.6 package hardens the Markdown parser's failure boundary: bounded collectors — including the strict security collector — now fail closed (a collector failure raises a typed error rather than returning a partial success), optional plugins fail closed on initialization errors, and parse computes source identity over the original bytes and rejects invalid UTF-8 with a typed input error. 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.6.tar.gz (446.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.6-py3-none-any.whl (415.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frontmattering-0.4.6.tar.gz
  • Upload date:
  • Size: 446.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.6.tar.gz
Algorithm Hash digest
SHA256 0afc857a872c582ef78e7847ed1eddef5cb0c203ec60722a0725c5b2de7a44e7
MD5 a1f0eeee5555fcc1f4059249ce04535c
BLAKE2b-256 0c20f50d2822d77fb9b93c40ce2f11879d7689f01a336c2c13a23bfc05901283

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frontmattering-0.4.6-py3-none-any.whl
  • Upload date:
  • Size: 415.3 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ec0bdc1b886281b1e84f2f8c4294b74f740cf94364c1327dbfcf927e8a22638d
MD5 1bd39cf382f661c167a6041751053cc9
BLAKE2b-256 94988c6853ae168f2f5e35778feb60b145a65fa27d99384da215b495a5c84e17

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