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.3.tar.gz (7.2 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.3-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for eizen_sdk-0.1.3.tar.gz
Algorithm Hash digest
SHA256 6cc8cf7c3b6f0d7c9335b851ad3d70ff8fabafdfe3412b29cf51504bec13f304
MD5 5a0297543dec3eed2fe61effdd311a59
BLAKE2b-256 7ca5bccfda06266d6221090a1b80036346f0365952c2e0b1ae1f4060058680fb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for eizen_sdk-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 94c06ad49ea0f445c73430b7b2bea3f06d9bd76fcfa5cb866e74b7d518b1f7ef
MD5 7434ec71127f923776e31d98ef36c36a
BLAKE2b-256 7e4eece0d068c74893c1d228489ff3bd44243bf0f09b6e1d4018b751fe16f0da

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