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

Uploaded Python 3

File details

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

File metadata

  • Download URL: eizen_sdk-0.1.11.tar.gz
  • Upload date:
  • Size: 10.5 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.11.tar.gz
Algorithm Hash digest
SHA256 f5184b7f0992ddd7eafa4815207d26de437b0c2bac923ac02d4a017d0e20c206
MD5 e92746b411da8aaf98f7fb129c53c64f
BLAKE2b-256 3762db01b60293a39139edf2463107b86c8bc49bb2b0be17b4606d6b17311862

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eizen_sdk-0.1.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5b2c15adb9efcd1f81b2a2ee04b302335701e732e21e8cce5e52ae558eb71974
MD5 2ee5330fb94aaf98d6c0165980311466
BLAKE2b-256 6b67d156d0b3ef22fcc4fbf3f2c8813fec4400ea3c5436ec59d852afe8cab217

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