Skip to main content

A SDK to consume Eizen services

Project description

EizenSDK

EizenSDK is a Python package that provides a simple interface to interact with the Eizen Analytics API. It handles authentication using Keycloak and provides methods to fetch analytics, zones, sources, and video summaries.

Installation

Ensure you have Python 3.7+ installed. Then, install the package:

pip install eizen-sdk

Usage

Importing and Initializing the SDK

from eizen_sdk import EizenSDK

sdk = EizenSDK(
    username="your_email@example.com",
    password="your_password"
)

Fetching Analytics

analytics = sdk.get_analytics()
print(analytics)

Fetching Zones for an Analytic

zones = sdk.get_analytic_zones(analytic_id=123)
print(zones)

Fetching Sources for a Zone

sources = sdk.get_zone_sources(zone_id=456)
print(sources)

Fetching Sources for an Analytic

sources = sdk.get_analytic_sources(analytic_id=123)
print(sources)

Fetching Source Details

source_details = sdk.get_source_details(source_id=789)
print(source_details)

Fetching Source Summary

source_summary = sdk.get_source_summary(source_id=789)
print(source_summary)

Authentication

EizenSDK handles authentication using Keycloak. It fetches an access token during initialization and refreshes it automatically when expired.

Error Handling

If any request fails, an exception is raised with the HTTP status code and error message.

License

This project is licensed under the MIT License.

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

eizen_sdk-0.1.9.tar.gz (2.1 kB view details)

Uploaded Source

Built Distribution

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

eizen_sdk-0.1.9-py3-none-any.whl (2.1 kB view details)

Uploaded Python 3

File details

Details for the file eizen_sdk-0.1.9.tar.gz.

File metadata

  • Download URL: eizen_sdk-0.1.9.tar.gz
  • Upload date:
  • Size: 2.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for eizen_sdk-0.1.9.tar.gz
Algorithm Hash digest
SHA256 62e4e2137008b6b70ab8ac7445c456c01c963c6de638b43ad4c512c333461452
MD5 1bb32650b10b33250807914e06b1f9f8
BLAKE2b-256 0e81ffd341b800c8d51750d8309b10819ff2da6035071c10a4c73061d145a26e

See more details on using hashes here.

File details

Details for the file eizen_sdk-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: eizen_sdk-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 2.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for eizen_sdk-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 73786c287432bbeb35faadc8fd3556561d324fa3e78576bf85d280e3eb65f874
MD5 71adeafd39dbce7503d3f1315823241a
BLAKE2b-256 3b03afbebdb0d93b7a1ef6646e6ded147deca3d0de58599463834800f7adf67e

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