Skip to main content

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

Reason this release was yanked:

Security: superseded by 0.9.4

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.10 package extends the destructive-output policy to every command: schema and index build refuse to overwrite an existing/non-index file (use --force); index delete refuses a path that is not a Frontmattering index; and new / promote --output refuse destinations outside the selected corpus (before writing), with promote --output <input> no longer acting as an implicit in-place rewrite. 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.10.tar.gz (457.5 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.10-py3-none-any.whl (419.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frontmattering-0.4.10.tar.gz
  • Upload date:
  • Size: 457.5 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.10.tar.gz
Algorithm Hash digest
SHA256 c503a602b0e1149a11b6c5afe9a3bfd3bad10335d6882bd3233ec82064fbe838
MD5 5cda810be3b5c343bd70651d32f3c1f7
BLAKE2b-256 32871d698c5f5a3e231eca84983c757e0c78e902bcc1076e887cb52398e1221c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for frontmattering-0.4.10-py3-none-any.whl
Algorithm Hash digest
SHA256 de87079e14b8082bd42599c25793c4045b978b8b7b3e961906d437f5b8874c34
MD5 8384b7399fee44d9282caa9a5533bf38
BLAKE2b-256 c0f006d43921add06d8a371597c1204db7f0b78e7a7226691e822ffe927df859

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