How openproficiency/opm-go works
opm-go is a Go library for defining and exchanging Open Proficiency Model data. Its principal workflow is to represent topic lists, record scores as transcript entries, and evaluate those entries against score interpretations to produce pass/fail results. The library also supports JSON/YAML encoding, schema validation, detached OpenPGP signing and verification, and topic-list dependencies. Edges reflect the README workflow and sampled imports or calls; unsampled dependency-resolution behavior is represented as a capability, without asserting its internal call path.
Main entry points: topic.go Topic lists · list.go Interpretation lists · entry.go Transcript entries · schema.go OPM schemas
Components 18
OPM Data
- Topic lists
topic/topic.go - Transcript entries
transcript/entry.go - Transcript collections
transcript/entries.go - Score levels
score/score.go - Topic encoding
topic/topic.go - Entry encoding
transcript/wire.go
Interpretation
- Interpretation lists
scoreinterpretation/list.go - Requirement expressions
scoreinterpretation/requirement.go - Score evaluation
scoreinterpretation/result.go - Interpretation validation
scoreinterpretation/validate.go - Interpretation encoding
scoreinterpretation/wire.go
Validation and Trust
- Signing operations
scoreinterpretation/sign.go - Entry signing
transcript/sign.go - OPM schemas
internal/schema/schema.go
Shared Primitives
- Semantic checks
internal/semantic/semantic.go - Canonical data
internal/canonical/canonical.go - OpenPGP operations
internal/pgp/pgp.go
Other components
- Library user
Connections 34
- Library user → Topic lists: defines
README.md - Library user → Interpretation lists: defines
README.md - Library user → Transcript entries: issues
README.md - Library user → Score evaluation: requests evaluation
README.md - Topic lists → Topic encoding: encodes and decodes
topic/topic.go - Topic lists → OPM schemas: validates against
topic/topic.go - Topic lists → Canonical data: captures signature state
topic/topic.go - Topic lists → OpenPGP operations: signs and verifies
topic/topic.go - Topic lists → Semantic checks: checks values
topic/topic.go - Transcript entries → Score levels: uses levels
transcript/entry.go - Transcript entries → Semantic checks: checks values
transcript/entry.go - Transcript collections → Transcript entries: encodes entries
transcript/entries.go - Transcript collections → OPM schemas: validates transcripts
transcript/entries.go - Entry encoding → OPM schemas: validates signed entries
transcript/wire.go - Entry encoding → Canonical data: captures protected state
transcript/wire.go - Interpretation lists → Interpretation validation: validates
scoreinterpretation/validate.go - Interpretation lists → Interpretation encoding: encodes and decodes
scoreinterpretation/wire.go - Interpretation lists → Score evaluation: evaluates entries
scoreinterpretation/result.go - Interpretation lists → Requirement expressions: contains expressions
README.md - Score evaluation → Transcript entries: reads scores
scoreinterpretation/result.go - Score evaluation → Score levels: compares levels
scoreinterpretation/result.go - Interpretation validation → OPM schemas: validates against
scoreinterpretation/validate.go - Interpretation encoding → OPM schemas: validates encoded lists
scoreinterpretation/wire.go - Interpretation encoding → Canonical data: builds protected data
scoreinterpretation/wire.go - Interpretation encoding → Score levels: decodes thresholds
scoreinterpretation/wire.go - Interpretation encoding → Topic lists: uses dependencies
scoreinterpretation/wire.go - Signing operations → Interpretation lists: signs list data
scoreinterpretation/sign.go - Signing operations → Canonical data: canonicalizes data
scoreinterpretation/sign.go - Signing operations → OpenPGP operations: signs and verifies
scoreinterpretation/sign.go - Entry signing → Transcript entries: signs entry data
transcript/sign.go - Entry signing → Canonical data: canonicalizes data
transcript/sign.go - Entry signing → OpenPGP operations: signs and verifies
transcript/sign.go - OPM schemas → Semantic checks: registers format checks
internal/schema/schema.go - Interpretation validation → Semantic checks: checks values
scoreinterpretation/validate.go