Skip to content

Add static registry curation metadata#14

Open
aidankhogg wants to merge 1 commit into
feat/lib/computecommonsfrom
codex/update-static-registry-modules-wzjpry
Open

Add static registry curation metadata#14
aidankhogg wants to merge 1 commit into
feat/lib/computecommonsfrom
codex/update-static-registry-modules-wzjpry

Conversation

@aidankhogg

Copy link
Copy Markdown
Contributor

Motivation

  • Provide immutable provenance and curation metadata for compact static registries so the core package remains small and clearly documented.
  • Capture source_url, a package curation version, and compactness_notes to signal that large external registries should be distributed via optional data packages rather than embedded in core.

Description

  • Add an immutable RegistryMetadata dataclass with new fields package_curation_version and compactness_notes and update source_version naming (src/.../static/metadata.py).
  • Add metadata constants beside each registry (ARCHITECTURE_ALIASES_METADATA, FILESYSTEMS_METADATA, MEDIA_TYPES_METADATA, OPERATING_SYSTEMS_METADATA, WELL_KNOWN_PORTS_METADATA, IP_PROTOCOL_NUMBERS_METADATA, VENDORS_METADATA) including source_url, package_curation_version, and compactness_notes (src/.../static/*.py).
  • Keep registry containers immutable (tuples and MappingProxyType) and do not embed large external registries; document optional companion data packages including computecommons-data-iana, computecommons-data-pci, computecommons-data-usb, and newly documented computecommons-data-oui in README.md.
  • Update tests to assert presence and immutability of the new metadata fields (tests/test_static.py).

Testing

  • Ran linter checks with python -m ruff check src/computecommons/static tests/test_static.py and they passed.
  • Ran focused tests with python -m pytest tests/test_static.py and full test-suite with python -m pytest, and all tests passed (8 passed for the focused run and 93 passed for the full suite).

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant