bijux-proteomics-foundation 0.3.3

Schema governance and canonical serialization primitives for reproducible proteomics documents and cross-package compatibility

bijux-proteomics-foundation

Package Family

bijux-proteomics-foundation provides the shared schema and serialization layer for the package family, including canonical JSON behavior, document fingerprinting, and compatibility contracts for persisted scientific records.

Use this package when you need versioned document governance, migration-safe serialization, and cross-package consistency for reproducible proteomics data.

Why teams pick this package

• one canonical schema baseline across every proteomics package
• stable fingerprints for cache keys, lineage, and provenance checks
• compatibility helpers for migration-safe long-lived scientific records
• typed primitives that reduce duplicated schema logic in downstream packages

Typical use cases

• define document schema metadata with explicit version and compatibility policy
• serialize domain models into canonical JSON for reproducible comparisons
• validate migration paths before accepting persisted record upgrades
• centralize schema behavior so other packages stay focused on domain logic

Installation

pip install bijux-proteomics-foundation

Quick start

from bijux_proteomics_foundation import schema, serialization

Package boundaries

This package owns schema metadata, canonical serialization, and migration compatibility helpers.

It does not own product decision logic, lab logic, or runtime orchestration.

Source guide

• src/bijux_proteomics_foundation/schema.py for schema profile and compatibility contracts
• src/bijux_proteomics_foundation/serialization.py for canonical serialization and fingerprints
• src/bijux_proteomics_foundation/migrations.py for migration behavior
• tests for executable behavior expectations

Documentation

• Package guide
• Ownership boundary
• Architecture overview
• Interface contracts
• Release and versioning