Skip to main content

Installable ADR and SPEC extension pack for HTTP caching and freshness governance.

Project description

cache-freshness-governance-pack

PyPI version Downloads Hits Python versions License CI

GitHub repo

cache-freshness-governance-pack is a small SSOT-compatible document pack for HTTP caching, freshness, validators, stale response controls, targeted cache policy, and CDN-facing cache governance.

It is designed to be published to PyPI and consumed by ssot-registry as an installable extension-pack document source. This repository does not perform downstream mutation itself. Its job is to ship immutable ADR and SPEC artifacts plus manifests that a downstream ssot-registry runtime can sync into the downstream .ssot registry.

The packaged distribution has one document artifact surface: src/cache_freshness_governance_pack/templates/. This repository does not package or maintain a parallel .ssot/registry.json.

What is in scope

  • upstream ADRs for cache/freshness governance decisions
  • upstream SPECs for HTTP cache policy, validators, revalidation, and CDN-facing controls
  • review inventories for RFC, IETF, and IANA cache/freshness targets
  • packaged manifests for ADR and SPEC discovery
  • a minimal Python loader module for runtime consumption

What is intentionally out of scope

  • downstream feature, claim, test, evidence, boundary, or release mutation
  • CDN vendor-specific policy beyond standards-targeted governance rows
  • runtime cache implementation, purge API implementation, or proxy deployment logic

Canonical layout

  • repo-local source ADRs: .ssot/adr/
  • repo-local source SPECs: .ssot/specs/
  • standards target inventory: docs/standards/cache-freshness-rfc-ietf-targets.md
  • packaged ADR templates: src/cache_freshness_governance_pack/templates/adr/
  • packaged SPEC templates: src/cache_freshness_governance_pack/templates/specs/

The repo-local .ssot documents are the authored source files in this repository. The packaged templates and manifests are the only shipped distribution artifact and are derived with:

python scripts/sync_packaged_docs.py

Programmatic usage

from cache_freshness_governance_pack import load_document_manifest, read_packaged_document_text

adr_manifest = load_document_manifest("adr")
spec_manifest = load_document_manifest("spec")
print(adr_manifest[0]["id"])
print(spec_manifest[0]["id"])

text = read_packaged_document_text("spec", "SPEC-0900-cache-freshness-governance-target-review.yaml")
print(text[:120])

Initial upstream documents

  • adr:0900 cache/freshness standards targets are reviewed before governance inclusion
  • spc:0900 cache/freshness governance target review

Review target inventory

Start with docs/standards/cache-freshness-rfc-ietf-targets.md. It separates core candidates, supporting candidates, historical/superseded context, and non-IETF watchlist items so ADR and SPEC inclusion can be decided deliberately.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cache_freshness_governance_pack-0.1.1.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file cache_freshness_governance_pack-0.1.1.tar.gz.

File metadata

File hashes

Hashes for cache_freshness_governance_pack-0.1.1.tar.gz
Algorithm Hash digest
SHA256 be3fc609326dbfe2ae405855eba9ca588c89a9c2fbc5eb1c82daeaac06182d7e
MD5 fbc915b96dd69377f3e7495dc64ab7a1
BLAKE2b-256 ab60dede42156834533ba8a61971d3dc25a051f088c59db1fa5b5b6332639769

See more details on using hashes here.

Provenance

The following attestation bundles were made for cache_freshness_governance_pack-0.1.1.tar.gz:

Publisher: publish.yml on groupsum/cache-freshness-governance-pack

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cache_freshness_governance_pack-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for cache_freshness_governance_pack-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 07d312d5f6c9dd7efe0567df9b0a4ffb0ee990e382fb73d2368720771232ad39
MD5 4d04e78aceb820f81df04a2fd7f1f836
BLAKE2b-256 4a15c070f8266899e666e2465155951734ae594cb2b09b7e99b275d51812f81f

See more details on using hashes here.

Provenance

The following attestation bundles were made for cache_freshness_governance_pack-0.1.1-py3-none-any.whl:

Publisher: publish.yml on groupsum/cache-freshness-governance-pack

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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