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.10.tar.gz (10.4 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.10-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eizen_sdk-0.1.10.tar.gz
  • Upload date:
  • Size: 10.4 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.10.tar.gz
Algorithm Hash digest
SHA256 453585370ee70bff74816deede60b5f0175f8b4f24492689f49d3e5b38e2aad9
MD5 451dfda47d99688234d89f73114e8b4e
BLAKE2b-256 4d0cbaf4ba94c8f5e55248fe17456cbe212a934142852e484e582d58c3ff227a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eizen_sdk-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 9.7 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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 04e9e948d09be38331fb91d23c38e1c033b47cb18a2cb6f71d3501b3cb244d45
MD5 61b0b611e6c0447c5c75e08c619c4c44
BLAKE2b-256 a90720b6badf99352ee8d7855ad1b7317de7a07aef07fbbbfa8ba074f1298589

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