Skip to content

index.md

Latest commit

 

History

History
32 lines (23 loc) · 1.12 KB

index.md

File metadata and controls

32 lines (23 loc) · 1.12 KB

Examples Directory

This section contains interactive Jupyter notebook examples demonstrating how to use the Sift Python client library.

Available Examples

  • Basic Usage - Introduction to the Sift Python client, covering basic operations and API usage
  • Data Ingestion - Learn how to ingest telemetry data into Sift using various methods
  • Pytest Plugin - Turn a pytest run into a Sift TestReport with measurements, nested steps, and pass/fail outcomes

Running Examples Locally

To run these examples on your local machine:

  1. Install the Sift Python client:

    pip install sift-stack-py

  2. Set up your environment variables in a .env file next to the notebook files:

    SIFT_API_KEY="your-api-key"
SIFT_GRPC_URI="your-sift-grpc-url"
SIFT_REST_URI="your-sift-rest-url"

  3. Open the notebooks in Jupyter after downloading them:

    jupyter notebook

For more examples including command-line scripts, see the examples directory in the repository.