Skip to main content

lightdash-client-python

A client library for accessing Lightdash API

Usage

First, create a client:

from lightdash_client import Client

client = Client(base_url="https://api.example.com")

If the endpoints you're going to hit require authentication, use AuthenticatedClient instead:

from lightdash_client import AuthenticatedClient

client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")

Now call your endpoint and use your models:

from lightdash_client.models import MyDataModel
from lightdash_client.api.my_tag import get_my_data_model
from lightdash_client.types import Response

my_data: MyDataModel = get_my_data_model.sync(client=client)
# or if you need more info (e.g. status_code)
response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)

Or do the same thing with an async version:

from lightdash_client.models import MyDataModel
from lightdash_client.api.my_tag import get_my_data_model
from lightdash_client.types import Response

my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)

By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.

client = AuthenticatedClient(
    base_url="https://internal_api.example.com",
    token="SuperSecretToken",
    verify_ssl="/path/to/certificate_bundle.pem",
)

You can also disable certificate validation altogether, but beware that this is a security risk.

client = AuthenticatedClient(
    base_url="https://internal_api.example.com",
    token="SuperSecretToken",
    verify_ssl=False
)

There are more settings on the generated Client class which let you control more runtime behavior, check out the docstring on that class for more info.

Things to know:

  1. Every path/method combo becomes a Python module with four functions:

    1. sync: Blocking request that returns parsed data (if successful) or None
    2. sync_detailed: Blocking request that always returns a Request, optionally with parsed set if the request was successful.
    3. asyncio: Like sync but async instead of blocking
    4. asyncio_detailed: Like sync_detailed but async instead of blocking
  2. All path/query params, and bodies become method arguments.

  3. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)

  4. Any endpoint which did not have a tag will be in lightdash_client.api.default

Example: Get dashboards in a project

Here is an example to get all dashboards in a project.

from lightdash_client import AuthenticatedClient
from lightdash_client.api.dashboard import get_dashboards

api_key = "..."
project_uuid = "..."

client = AuthenticatedClient(base_url="https://app.lightdash.cloud/api/v1", token=api_key)

dashboards = get_dashboards.sync(client=client, project_uuid=project_uuid)
print(dashboards)

Metadata

Release files for lightdash-client-python 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lightdash-client-python 0.1.2
File Size Uploaded Provenance Actions
lightdash_client_python-0.1.2.tar.gz 49.5 kB Without provenance Details for lightdash_client_python-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for lightdash-client-python 0.1.2
File Interpreter ABI Platform Actions
lightdash_client_python-0.1.2-py3-none-any.whl Python 3 none any Details for lightdash_client_python-0.1.2-py3-none-any.whl

Total release size: 168.0 kB

Release files / lightdash_client_python-0.1.2.tar.gz

Download URL lightdash_client_python-0.1.2.tar.gz
Size 49.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0079e09303667e0a64bea675c1860b737e529622ad73743b43fd5b46b7c9aadc
BLAKE2b-256 checksum
How to use checksums
3ff70880fc628bd67c9aef65aa225889eb8eeeeb866d2408cd98c59c7720d6d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Release files / lightdash_client_python-0.1.2-py3-none-any.whl

Download URL lightdash_client_python-0.1.2-py3-none-any.whl
Size 118.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
50bb0c28ea207f8565973c4ba69261933283ff9b35ce3c2e44dbebba61e911c1
BLAKE2b-256 checksum
How to use checksums
7c48675f15a2a30324eefd807aa8f33ee962f30e61aeb53b9e0bdc1fdf8e00b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-requests/2.31.0

Security for lightdash-client-python 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page