Skip to main content

A Python SDK for Evntaly event tracking platform

Project description

Evntaly Cover

Evntaly

An advanced event tracking and analytics platform designed to help developers capture, analyze, and react to user interactions efficiently.

PyPI version PyPI downloads license

evntaly-python

EvntalySDK is a Python client for interacting with the Evntaly event tracking platform. It provides methods to initialize tracking, log events, identify users, and check API usage limits.

Features

  • Initialize the SDK with a developer secret and project token.
  • Track events with metadata and tags.
  • Identify users for personalization and analytics.
  • Check API usage limits before sending events.
  • Enable or disable tracking globally.

Installation

Install the SDK using pip:

pip install evntaly-python

Usage

Initialization

Initialize the SDK with your developer secret and project token:

from evntaly_python import EvntalySDK 

evntaly = EvntalySDK("YOUR_DEVELOPER_SECRET", "YOUR_PROJECT_TOKEN")

Tracking Events

To track an event:

evntaly.track({
    "title": "Payment Received",
    "description": "User completed a purchase",
    "message": "Order #12345",
    "data": {
        "user_id": "67890",
        "timestamp": "2025-01-08T09:30:00Z",
        "referrer": "social_media",
        "email_verified": True
    },
    "tags": ["purchase", "payment"],
    "notify": True,
    "icon": "💰",
    "apply_rule_only": False,
    "user": {"id": "0f6934fd-99c0-41ca-84f4"},
    "type": "Transaction",
    "sessionID": "20750ebc-dabf-4fd4-9498-443bf30d6095_bsd",
    "feature": "Checkout",
    "topic": "@Sales"
})

Identifying Users

To identify a user:

evntaly.identify_user({
    "id": "0f6934fd-99c0-41ca-84f4",
    "email": "user@example.com",
    "full_name": "John Doe",
    "organization": "ExampleCorp",
    "data": {
        "id": "JohnD",
        "email": "user@example.com",
        "location": "USA",
        "salary": 75000,
        "timezone": "America/New_York"
    }
})

Enabling/Disabling Tracking

Control event tracking globally:

evntaly.disable_tracking()  # Disables tracking
evntaly.enable_tracking()   # Enables tracking

License

This project is licensed under the MIT License.


Note: Replace 'YOUR_DEVELOPER_SECRET' and 'YOUR_PROJECT_TOKEN' with actual credentials.

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

evntaly_python-1.0.14.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

evntaly_python-1.0.14-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file evntaly_python-1.0.14.tar.gz.

File metadata

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

File hashes

Hashes for evntaly_python-1.0.14.tar.gz
Algorithm Hash digest
SHA256 3becee8368ec20edc5a4c665613cf3ea09576aa6e3df3caffc7ea7d42431a45c
MD5 d069e690dfded921a8745a968e0b227b
BLAKE2b-256 2db015bb62f46dddffcad46477dbf34e6d349ca4f9c77948c34a13357c121244

See more details on using hashes here.

File details

Details for the file evntaly_python-1.0.14-py3-none-any.whl.

File metadata

File hashes

Hashes for evntaly_python-1.0.14-py3-none-any.whl
Algorithm Hash digest
SHA256 d41487a1d9074fb421f6c156123c4b2ab749c1c530e52908906940af1e2c57bf
MD5 bc84214196a027b1989cbb0eba1b4003
BLAKE2b-256 2cdfd4fcecfe18c371a095d784162cc1ca1a2a274ca85b54413f029f318abbac

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