Skip to main content

Metrics Layer

Github Actions codecov Code style: black

What is a Metrics Layer?

Metrics Layer is an open source project with the goal of making access to metrics consistent throughout an organization. We believe you should be able to access consistent metrics from any tool you use to access data. This metrics layer is designed to work with Zenlytic as a BI tool.

How does it work?

Zenlytic is the only supported BI tool. The Metrics Layer will read your data model and give you the ability to access those metrics and dimensions in a python client library, or through SQL with a special MQL tag.

Sound interesting? Here's how to set Metrics Layer up with your data model and start querying your metrics in in under 2 minutes.

Installation

Make sure that your data warehouse is one of the supported types. Metrics Layer currently supports Snowflake, BigQuery, Postgres, Druid (only SQL compilation, not running the query), DuckDB (only SQL compilation, not running the query), SQL Server (only SQL compilation, not running the query), and Redshift, and only works with python >= 3.8 up to python < 3.11.

Install Metrics Layer with the appropriate extra for your warehouse

For Snowflake run pip install metrics-layer[snowflake]

For BigQuery run pip install metrics-layer[bigquery]

For Redshift run pip install metrics-layer[redshift]

For Postgres run pip install metrics-layer[postgres]

Profile set up

There are several ways to set up a profile, we're going to look at the fastest one here.

The fastest way to get connected is to pass the necessary information directly into Metrics Layer. Once you've installed the library with the warehouse you need, you should be able to run the code snippet below and start querying.

You'll pull the repo from Github for this example. For more detail on getting set up, check out the documentation!

from metrics_layer import MetricsLayerConnection

# Give metrics_layer the info to connect to your data model and warehouse
config = {
  "location": "https://myusername:myaccesstoken@github.com/myorg/myrepo.git",
  "branch": "develop",
  "connections": [
    {
      "name": "mycompany",              # The name of the connection in your data model (you'll see this in model files)
      "type": "snowflake",
      "account": "2e12ewdq.us-east-1",
      "username": "demo_user",
      "password": "q23e13erfwefqw",
      "database": "ANALYTICS",
      "schema": "DEV",                  # Optional
    }
  ],
}
conn = MetricsLayerConnection(**config)

# You're off to the races. Query away!
df = conn.query(metrics=["total_revenue"], dimensions=["channel", "region"])

For more advanced methods of connection and more information about the project check out the docs

Download files

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

Source Distribution

metrics_layer-0.16.41.tar.gz (141.9 kB view details)

Uploaded Source

Built Distribution

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

metrics_layer-0.16.41-py3-none-any.whl (165.7 kB view details)

Uploaded Python 3

File details

Details for the file metrics_layer-0.16.41.tar.gz.

File metadata

  • Download URL: metrics_layer-0.16.41.tar.gz
  • Upload date:
  • Size: 141.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.15 Linux/6.17.0-1020-azure

File hashes

Hashes for metrics_layer-0.16.41.tar.gz
Algorithm Hash digest
SHA256 e76c17dc5142f4d207506e5632e555899ac9b63d134bb7f18680ecf0096d6ed7
MD5 ab73ca46741a6e686aec99e72ea364ab
BLAKE2b-256 34a4a75be2d7975e921ed46d97accdcbf1e3195fde25cc6d603f677a6a131107

See more details on using hashes here.

File details

Details for the file metrics_layer-0.16.41-py3-none-any.whl.

File metadata

  • Download URL: metrics_layer-0.16.41-py3-none-any.whl
  • Upload date:
  • Size: 165.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.15 Linux/6.17.0-1020-azure

File hashes

Hashes for metrics_layer-0.16.41-py3-none-any.whl
Algorithm Hash digest
SHA256 4ffe46e1e67ebed48997bd6c64b20b2370e7d86a66753e6b12f2c63eef4b56bd
MD5 5cd53a9e88e18bc67b3bbf145980471c
BLAKE2b-256 9789df278e52ff6a00e7a2ff1eaf4c82bf5099e46f1722c3d14e27d7d3fd94d1

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

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