Skip to main content

ClearMetric Core — local compiler, graph engine, and CLI foundation.

Project description

clearmetric-core

One PyPI package. All ClearMetric Core modules ship inside this distribution.

Install

python -m pip install clearmetric-core

CLI (project-first)

cm init
cm connect warehouse --information-schema ./warehouse_schema.json
cm scan
cm compile --format json > graph.json
cm impact orders.amount --upstream
cm clean
cm contract graph.json

If cm is occupied on your PATH:

python -m clearmetric.cli --project-dir . compile --format json

Modules

Module Purpose
clearmetric.compiler Discover → adapters → merge → policy/cleaner spine
clearmetric.core Artifact schema, canonical IDs, merge, validation
clearmetric.lineage Project-level SQL lineage from dbt manifests and SQL folders
clearmetric.query Single-statement SQL structure mapping
clearmetric.powerbi PBIP file lineage (not in v0 warehouse CLI registry)
clearmetric.cli cm command router

Imports

from pathlib import Path
from clearmetric.compiler import compile
from clearmetric.core import CatalogArtifact, merge, parse_column_selection
from clearmetric.lineage import (
    build_catalog_artifact_from_project,
    load_project,
    trace_upstream_from_project,
)

For local development:

python -m pip install -e ".[dev,release]"

Contract

The source of truth for the shared artifact contract is docs/contract.md.

Project config schema: ../../spec/clearmetric-project.schema.json

Example project: ../../examples/wedge-jaffle

Project details


Download files

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

Source Distribution

clearmetric_core-0.3.0.tar.gz (55.5 kB view details)

Uploaded Source

Built Distribution

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

clearmetric_core-0.3.0-py3-none-any.whl (77.3 kB view details)

Uploaded Python 3

File details

Details for the file clearmetric_core-0.3.0.tar.gz.

File metadata

  • Download URL: clearmetric_core-0.3.0.tar.gz
  • Upload date:
  • Size: 55.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for clearmetric_core-0.3.0.tar.gz
Algorithm Hash digest
SHA256 7357ebee04bd8249498956a58ef62bc868b173884d4b1539dab0047de70f1c4e
MD5 019be7d03c8de1ebecd06b5c2bc5971f
BLAKE2b-256 4bba3c10c590d03787c4ec6c1eafb99b907801e138285c449c13a6f0d158405e

See more details on using hashes here.

Provenance

The following attestation bundles were made for clearmetric_core-0.3.0.tar.gz:

Publisher: publish.yml on ClearMetric-Labs/ClearMetric-Core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file clearmetric_core-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for clearmetric_core-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1b172c72da71b2995bee3a7fa793220d3c781243f93f3c987eadb8ecbf380797
MD5 43c69de7f4086630990de6e7f9dfe660
BLAKE2b-256 e73c89ae661b7787992098ce786385e38402e387407fd089c71eacce0d3d9ecd

See more details on using hashes here.

Provenance

The following attestation bundles were made for clearmetric_core-0.3.0-py3-none-any.whl:

Publisher: publish.yml on ClearMetric-Labs/ClearMetric-Core

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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