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.2.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.2-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: eizen_sdk-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 c037919e80cf48f70c1df84712787f9fd9f3d2d4f8ffc2c8615ed91b00d30431
MD5 d52d953bc06e7f6c11c51f4a91389ebc
BLAKE2b-256 5ea8e55b11352c67dc33be1f33d93ef17efa0e516f5b995076a392de51fb00c7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: eizen_sdk-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c7d3ec71b1b0cef645c5ab897866b1f6321851c6340f319f5dc21fed9d46f828
MD5 71a84f5f80cefb1842f412696e731f21
BLAKE2b-256 931839ac73d6a3643464074fe67825cbafab9677952fbf69edb2057c500135d2

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