Skip to main content

just-dna-format

The declarative schema + integrity contract for just-dna annotation modules: both the authored input DSL and the compiled manifest.json. Dependency-light (Pydantic + cryptography, for Ed25519 signature verification) so it can be shared as the single source of truth by:

  • just-dna-compiler — the reference transform (spec → parquet artifact + manifest);
  • just-dna-pipelinesemits manifest.json when it compiles a module;
  • just-dna-marketplaceindexes, serves, and verifies those manifests;
  • just-dna-agents — authoring support (renders reference.authoring_reference()).

Keeping the contract in one small package prevents the sides from drifting.

What's here

Module Contents
just_dna_format.spec The authored DSL: ModuleSpecConfig, VariantRow, StudyRow, ModuleInfo, Defaults (+ extract_pmids).
just_dna_format.binning The measure→phenotype primitive: MeasureBinRow + Activity/CopyNumber/RepeatAllele/Heteroplasmy rows and validate_bins (0.4).
just_dna_format.pgx PGx star-allele model: HaplotypeRow, AlleleFunctionRow, DiplotypeRow, PharmVariantRow (0.4).
just_dna_format.pgs PgsRow — a curated PGS-Catalog interface with ancestry-validity fields (0.4).
just_dna_format.vocab Shared constrained vocabularies, identifier grammars, and validator helpers.
just_dna_format.derive Legacy state/ClinVar-boolean → 0.3-axis derivations (total, idempotent).
just_dna_format.manifest ModuleManifest + sub-models (Identity, Display, Stats, Compilation, FileEntry, Artifact, Provenance, Signature, GenePanelSpec); read_manifest / write_manifest. SPEC §4.
just_dna_format.integrity sha256_file, artifact_digest (canonical Merkle root), build_artifact, verify_manifest, verify_signature, IntegrityError. SPEC §5.
just_dna_format.signing Ed25519 signing over artifact.digest (key management side).
just_dna_format.aggregate Cross-version log / provenance union helpers.
just_dna_format.reference authoring_reference() / json_schemas() — drift-proof DSL description generated from the live models.
just_dna_format.identity Name/namespace rules, canonical_id, SemVer Version + parse_version, version_from_legacy (vN → N.0.0), latest. SPEC §6.

Usage

from just_dna_format.manifest import ModuleManifest, read_manifest
from just_dna_format.integrity import build_artifact, verify_manifest

# Compiler side: hash outputs and record the digest.
artifact = build_artifact(output_dir, ["weights.parquet", "annotations.parquet", "studies.parquet"])

# Downloader side: verify before installing (raises IntegrityError on any mismatch).
verify_manifest(module_dir, read_manifest(module_dir / "manifest.json"))

All hashes are SHA-256, lowercase hex, prefixed sha256:. The artifact.digest is a Merkle-style root over the canonical file listing — verifying it verifies the whole set and is the version's immutable content identity.

Develop

uv sync
uv run pytest -vvv

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

just_dna_format-0.5.4.tar.gz (102.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

just_dna_format-0.5.4-py3-none-any.whl (120.0 kB view details)

Uploaded Python 3

File details

Details for the file just_dna_format-0.5.4.tar.gz.

File metadata

  • Download URL: just_dna_format-0.5.4.tar.gz
  • Upload date:
  • Size: 102.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for just_dna_format-0.5.4.tar.gz
Algorithm Hash digest
SHA256 2bab66e272fda5cab97ee4cefffd8082ad0df00b51b3a6a483fac5198352fb86
MD5 64f0532c5a19da90d36f6ccb30882410
BLAKE2b-256 d31b9d28104a67157c9ba8a0c108c4c27bf990d1cb55600efbafb9445713b631

See more details on using hashes here.

File details

Details for the file just_dna_format-0.5.4-py3-none-any.whl.

File metadata

  • Download URL: just_dna_format-0.5.4-py3-none-any.whl
  • Upload date:
  • Size: 120.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.17 {"installer":{"name":"uv","version":"0.9.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for just_dna_format-0.5.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2c0a4cb67d3fb19a85bead190bc0628921a25824fec95da9020f994c69f3c098
MD5 c0fa25d2f8b5baa6100343435f899770
BLAKE2b-256 6e8f17d15a0269b98512659aebf4b1364284511384a0529d3b885b93b69ae10b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page