topmark.pipeline.machine package index¶

Machine-output helpers for pipeline processing commands.

This package contains the pipeline domain implementation of TopMark's machine-readable output for topmark check and topmark strip.

Layers:

schemas: Typed schema fragments for pipeline-specific payloads (static typing only).
payloads: Pure payload builders for the pipeline domain (no meta/kind, no serialization).
shapes: Composition of domain payloads into full machine shapes:
JSON envelope (meta + config + config_diagnostics + results/summary)
NDJSON record stream (Pattern A: every record includes kind and meta)
serializers: Pure JSON/NDJSON serialization helpers that turn shaped objects/records into strings (no Click/Console printing).

Design goals: - Console-/Click-free (safe to reuse from non-CLI frontends). - Serialization separated from shaping (stable shapes, consistent output). - Shared conventions (keys/kinds/domains, normalization) come from topmark.core.machine.

Notes

Typed payload schemas, payloads, envelopes and serializers are available from: - topmark.pipeline.machine.schemas - topmark.pipeline.machine.payloads - topmark.pipeline.machine.envelopes - topmark.pipeline.machine.serializers Callers can be explicit about which layer they depend on.

See Also: - topmark.core.machine: shared machine-readable output primitives (keys/kinds/domains, envelopes/records, normalization, JSON/NDJSON serialization helpers).

Immediate children in this package¶

topmark.pipeline.machine.envelopes: Machine-output envelope builders for processing and probe commands.
topmark.pipeline.machine.payloads: Payload builders for pipeline-related machine-readable output.
topmark.pipeline.machine.schemas: Typed schema fragments for pipeline-related machine-readable output.
topmark.pipeline.machine.serializers: Pure JSON/NDJSON serializers for TopMark processing and probe machine-readable output.