magogi/prod/: mgf-doc-standard-0.1.4 metadata and description

Simple index

The Magogi Foundation engineering-standards corpus, federation contract, and library registry — the source of truth for the mgf-* federation

author Bassam Alsanie, mgf-doc-standard contributors
classifiers
  • Development Status :: 4 - Beta
  • Intended Audience :: Developers
  • License :: OSI Approved :: MIT License
  • Operating System :: OS Independent
  • Programming Language :: Python :: 3
  • Programming Language :: Python :: 3.11
  • Programming Language :: Python :: 3.12
  • Programming Language :: Python :: 3.13
  • Topic :: Documentation
  • Topic :: Software Development :: Documentation
  • Typing :: Typed
description_content_type text/markdown
keywords documentation, engineering-standards, federation, governance, standards
license MIT
license_file
  • LICENSE
project_urls
  • Homepage, https://codeberg.org/magogi-admin/mgf-doc-standard
  • Issues, https://codeberg.org/magogi-admin/mgf-doc-standard/issues
requires_dist
  • import-linter<3,>=2.0; extra == 'dev'
  • mypy<2,>=1.10; extra == 'dev'
  • pytest-cov<8,>=5.0; extra == 'dev'
  • pytest<10,>=8.0; extra == 'dev'
  • ruff<1,>=0.4; extra == 'dev'
requires_python >=3.11

Because this project isn't in the mirror_whitelist, no releases from root/pypi are included.

File Tox results History
mgf_doc_standard-0.1.4-py3-none-any.whl
Size
434 KB
Type
Python Wheel
Python
3

mgf-doc-standard

The Magogi Foundation's engineering-standards corpus, federation contract, and library registry — the single source of truth for the mgf-* federation.

Conformance: L2 per its own docs/standards/ (one documented CFM-04 carve-out — see docs/inprogress/MGF_STANDARDS_CONFORMANCE.md). Audience: every Magogi project (humans + AI agents). If you depend on mgf-common or any mgf-* sibling, the rules you follow live here.


What this repo is

mgf-doc-standard is the standards leaf of the Magogi Foundation. It carries, as the canonical version-controlled source of truth:

Why it's a separate repo (and a tiny package)

The standards used to live inside mgf-common. They were extracted so the rules version independently of the implementation: mgf-common is the reference implementation + the CLI front door; mgf-doc-standard is the specification. mgf-common now depends on mgf-doc-standard.

The repo ships a tiny, zero-dependency data package, mgf.doc_standard, that carries the corpus as wheel data and exposes a typed resolver:

import mgf.doc_standard as std

std.standards_dir()           # Path to the corpus directory
std.list_standards()          # ['API_DESIGN', 'CONFIGURATION', 'LOGGING', ...]
std.read_standard("LOGGING")  # the full LOGGING.md text

std.recipes_dir()             # Path to the federation-operations recipes
std.list_recipes()            # ['cohort-release-wave', 'federation-sync-prompt', ...]
std.read_recipe("federation-sync-prompt")  # the /sync prompt text

std.libraries()               # the federation registry (roster + dep graph)

It depends on nothing in the mgf.* namespace — it is the federation leaf-of-leaves, sitting below mgf-common in the dependency graph (mgf-doc-standardmgf-common ← every sibling ← every consumer), so the runtime graph stays acyclic.

How to read the standards

You almost never read this repo directly — you read it through mgf-common's CLI, which is installed in every federation project:

mgf-common standards            # list all topics
mgf-common standards LOGGING    # print one
mgf-common agents               # the canonical AI-agent briefing

Those commands resolve this package's corpus via mgf.doc_standard.standards_dir(). Reading the rules never requires a checkout of this repo.

Repo layout

Path What
FEDERATION.md The federation contract (canonical; others link here)
MGF_LIBRARIES.md The library registry (generated; REL-13 gate)
docs/standards/ The engineering-standards corpus (the rules)
docs/design/federation.md The federation-pattern architecture paper
docs/recipes/ Federation-operations recipes + templates
scripts/gen_mgf_libraries.py Registry generator + consistency gate
src/mgf/doc_standard/ The tiny resolver package (corpus shipped as data)

Federation links

License

MIT — see LICENSE.