Skip to main content

DashX Python SDK

Project description


DashX

Your All-in-One Product Stack


dashx-python

DashX SDK for Python

Install

pip install --upgrade dashx

Usage

For detailed usage, refer to the documentation.

Testing

Install the package in editable mode with dev dependencies, then run pytest from the project root:

pip install -e ".[dev]"
pytest

Tests use mocked requests (no real API calls) and set their own env vars via fixtures, so you do not need to set DASHX_PUBLIC_KEY or DASHX_PRIVATE_KEY to run tests.

  • Run with verbose output: pytest -v
  • Run a specific file: pytest tests/test_client.py
  • Run a specific test: pytest tests/test_client.py::TestIdentify::test_identify_with_uid_calls_make_request

Examples

The examples/ folder contains scripts that call the real DashX API. They require valid credentials via environment variables.

Required env vars: DASHX_PUBLIC_KEY, DASHX_PRIVATE_KEY, DASHX_TARGET_ENVIRONMENT
Optional: DASHX_BASE_URI (default: https://api.dashx.com/graphql)

From the project root:

export DASHX_PUBLIC_KEY=your_public_key
export DASHX_PRIVATE_KEY=your_private_key
export DASHX_TARGET_ENVIRONMENT=development

python -m examples.identify_example
python -m examples.track_example

Or with PYTHONPATH if the package isn’t installed: PYTHONPATH=src python -m examples.identify_example

See examples/README.md for more detail (e.g. using a .env file).

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

dashx-0.1.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

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

dashx-0.1.0-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file dashx-0.1.0.tar.gz.

File metadata

  • Download URL: dashx-0.1.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for dashx-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6ee184f0f6e02563d6fdaee46d8db5c08d80363ea1f33c334a804b983ddbe5e8
MD5 866e23264ff1a1115a399b83ec2ba16d
BLAKE2b-256 68914b4c6e587c8daf0ac42c428c2d3f99b903b0b3f4dd8b423b2730e25ce5bc

See more details on using hashes here.

File details

Details for the file dashx-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: dashx-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for dashx-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54129748ac84fd630aba9e109a0d0395952790c1e91bba6d97a3d15b9ed94a5c
MD5 02beed2995987700ec4e3588ab87d4a1
BLAKE2b-256 59323341f63d206b7ec56f03f9610cd0dba53f7b575c91d2d3e0f8d3b1e3526a

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 Pingdom Monitoring Sentry Error logging StatusPage Status page