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.0.tar.gz (3.3 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.0-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file eizen-sdk-0.1.0.tar.gz.

File metadata

  • Download URL: eizen-sdk-0.1.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.6

File hashes

Hashes for eizen-sdk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6bcf81b470395ab73db8714d588800643911603da727bad730796d5aeea888c1
MD5 9090ed079dc839e5d3836b5ff18d5835
BLAKE2b-256 281852de63a581f99e3748c87264485c6c420a0ab9462911e6ebb2b8a81f91db

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for eizen_sdk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7aa313bcbc64408907e46c2441e24b33383bc87dabe893e94165dc080764cbd
MD5 08dfeb955af290b117cbe280fc46c319
BLAKE2b-256 cba4a2df79d9880a37f58b9d38261cd9126760f9d18b8d1401cfc72ab4bb7d56

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