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. schema/index build --output can overwrite a router or project file, index delete can remove a non-index file, and new/promote --output can write outside the corpus. 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.9 package closes destructive-output defects: runtime pack never deletes an existing directory and refuses to overwrite a file without --force; parse --output refuses to overwrite its own input or an existing file without --force, and writes atomically; frontmatter-only authoring edits (such as the router task-catalog refresh) preserve body bytes; and the Markdown API path reader is strict byte-first UTF-8. 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.9.tar.gz (454.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.9-py3-none-any.whl (418.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frontmattering-0.4.9.tar.gz
  • Upload date:
  • Size: 454.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.9.tar.gz
Algorithm Hash digest
SHA256 e61ec7700be6316d22cd1f7fcd3c874da75e243c759fc3808b33e456e161e7dc
MD5 fcd03253663fc54c2873dec6aefe3b2a
BLAKE2b-256 76760a54d3b172524b33a4fca1e9e0ca08b027c957f8bf30666604768c249a12

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frontmattering-0.4.9-py3-none-any.whl
  • Upload date:
  • Size: 418.2 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2b496e467755c3f78fcee6d674fc7caf8e1f1a0f4e183430f77b8ae6fc36159f
MD5 78d0773c17b6b63d9b294db7851b4660
BLAKE2b-256 114b007775cc388b6fc7a6399662995ceb25509998d6c7370e86fd200d04daf1

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