sentinel-analytics-realm-python 0.0.3

Python SDK for Sentinel Analytics Realm

Sentinel Analytics Realm - Python SDK

Thin Python client for tracking events in the Sentinel Analytics Realm.

Installation

From PyPI (Public Channel)

pip install sentinel-analytics-realm-python

From Source (Local Development)

git clone https://github.com/savant-realms/sentinel-analytics-realm-python.git
cd sentinel-analytics-realm-python
pip install -e .

Usage

from sdk.sdk import SentinelAnalyticsRealmPlugin

# Initialize the plugin
sentinelAnalyticsRealm = SentinelAnalyticsRealmPlugin(
    project_id="YOUR_PROJECT_ID",
    app_id="YOUR_APP_ID",
    access_token="YOUR_ACCESS_TOKEN",
)

# Track an event
sentinelAnalyticsRealm.track("page_view", visitor_id="v_123")

# Identity linking
sentinelAnalyticsRealm.identify(user_id="u_456", visitor_id="v_123", traits={"email": "[e-mail]"})

# Batch tracking
sentinelAnalyticsRealm.track_batch([
    {"name": "click", "visitor_id": "v_123", "properties": {"button": "buy"}},
    {"name": "hover", "visitor_id": "v_123"}
])

Configuration fallback

The SDK will automatically attempt to read configuration from environment variables if not provided in the constructor:

• SENTINEL_ANALYTICS_REALM_PROJECT_ID
• SENTINEL_ANALYTICS_REALM_APP_ID
• SENTINEL_ANALYTICS_REALM_ENV
• SENTINEL_ANALYTICS_REALM_URL (Defaults to https://api.sentinelanalyticsrealm.com)

Local release (maintainers)

• Prepare .env at repo root with at least:
  • PYPI_TOKEN=pypi-... (Upload scope)
  • Optional GitLab upload:
    • GITLAB_PROJECT_ID=...
    • GITLAB_USERNAME=...
    • GITLAB_TOKEN=... (PAT with api scope or Deploy Token)
• Run:
  • scripts/deploy.sh to build, validate, and upload.
  • DRY_RUN=true scripts/deploy.sh to build + check only.