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. Fail-open collectors, false parse source identity, runtime GO over zero paths, 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.5 package makes the documented first-hour path executable verbatim from an empty directory — it uses frontmattering new, and the README's fenced quickstart block is executed as a CI release gate — and removes the dormant network-fetch helper from the distribution. 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.5.tar.gz (444.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.5-py3-none-any.whl (414.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frontmattering-0.4.5.tar.gz
  • Upload date:
  • Size: 444.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.5.tar.gz
Algorithm Hash digest
SHA256 bb91c3e5f8b7cc36a0b5a89b221c7cae124305dd611393e87d681388dfb5aac2
MD5 23f2136ed17a3ef0df9a623167a9e261
BLAKE2b-256 1f7119a168b833b015b1f2264a6c003651c0004d704d4d274f4a7668880c4d87

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frontmattering-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 414.6 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 201b06723b6f73d09f84edead7336c34291b3ac00afb1fc42484027e4d85948f
MD5 2f6479d9f96fbcdc44302246b1c7f144
BLAKE2b-256 3fbe96939b4a3741bc97365a18b8e89401868597da359d544e8aed15c3dfb35e

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