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. Quickstart still promotes non-existent files; fail-open collectors and destructive output/runtime surfaces remain. 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

Initialize governance at your repository root; your Markdown lives under docs/ (the default corpus is docs/**/*.md). promote takes one file per call, and exactly one document is the router.

frontmattering init . --set-id MYDOCS --title "My docs"
frontmattering promote docs/INDEX.md --profile router --in-place
frontmattering promote docs/GUIDE.md --profile guide --in-place
frontmattering tether update --add .
frontmattering validate .
frontmattering brief .

Promote each additional document with its own frontmattering promote <file> --profile guide --in-place call. Promoting a file that is not inside 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 run:

frontmattering validate .
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.4 package hardens the first-hour path: the quickstart initializes at the repository root, promote --in-place is transactional (it fails before mutation when a target is outside the selected corpus, FRONTMATTERING-AUTHORING-TARGET-OUTSIDE-CORPUS), and the validate-only runtime corrects its --help and no-path behavior. 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.4.tar.gz (445.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.4-py3-none-any.whl (418.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frontmattering-0.4.4.tar.gz
  • Upload date:
  • Size: 445.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.4.tar.gz
Algorithm Hash digest
SHA256 8e018e16f3449622fd43c68852e54f155b3d09f0764e2984d8aca8a57b7b8a59
MD5 cb75cc6dfe6f43776f9c6faa33c5c697
BLAKE2b-256 fb9e5e96a9c86faac1d42055892b9aa73b0fbee149777bc88bd398395e8ad67a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frontmattering-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 418.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 553c1f8885f8f70d67da8bae8fa6110383e8bd9843e7ffd972e85931159f3a33
MD5 9aaa7ae519a05fbd94d01b1b0da265c2
BLAKE2b-256 dd6d6cbb69a8c09d7abd57dd8e4781e8a9bd37f188046cca30fc7769baa3e981

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