Minimal Snowplow Tracker

Warnings

• breaking This library (version 0.0.2) is a highly minimal fork of the original `snowplow-python-tracker` (v0.8.0). It has removed all emitters except the basic one and all tracking event methods except for structured and unstructured events. Functionality available in newer versions of the official `snowplow-tracker` will not be present.
  Fix: For comprehensive and up-to-date Snowplow tracking features, use the actively maintained `snowplow-tracker` library (pypi.org/project/snowplow-tracker/). If `minimal-snowplow-tracker` is a dependency, consider whether the older, limited functionality is sufficient or if an alternative tracking approach is needed.
• gotcha The `minimal-snowplow-tracker` package, when installed, exposes its functionality under the `snowplow_tracker` Python module namespace. This creates a direct import conflict if the official, actively maintained `snowplow-tracker` library is also installed in the same environment, as both will try to provide modules under the same `snowplow_tracker` path.
  Fix: Avoid installing `minimal-snowplow-tracker` alongside the official `snowplow-tracker` in the same Python environment. If `minimal-snowplow-tracker` is a transitive dependency (e.g., via `dbt-core`), be aware of this potential conflict and manage your environment carefully, perhaps using virtual environments.
• deprecated `minimal-snowplow-tracker` was last updated in October 2018 and officially supports Python up to 3.7. It is not actively maintained as a public library and is significantly behind the upstream `snowplow-python-tracker`. Using it with newer Python versions might lead to compatibility issues.
  Fix: Migrate to the official and actively maintained `snowplow-tracker` library for Python. If adherence to Python 3.7 or earlier is required, ensure rigorous testing for compatibility.
• gotcha The PyPI page for `minimal-snowplow-tracker` points to the `snowplow/snowplow-python-tracker` GitHub repository for its 'Contributing quickstart', which describes a testing setup and not a typical application usage. This reinforces that `minimal-snowplow-tracker` is not designed for direct end-user application integration, and its documentation is not for its specific minimal feature set.
  Fix: If you intend to use a Snowplow Python tracker, consult the official documentation and GitHub for the actively maintained `snowplow-tracker` library to ensure correct implementation and access to supported features.

Install

• pip install minimal-snowplow-tracker Install with pip

Imports

• Tracker

  from snowplow_tracker import Tracker

  Despite being installed as `minimal-snowplow-tracker`, the package uses the `snowplow_tracker` namespace internally, which can cause import conflicts if the official `snowplow-tracker` library is also installed.
• Emitter

  from snowplow_tracker import Emitter

  This minimal fork only retains the basic Emitter. Other emitters (e.g., Kafka, AMQP) from the original tracker are removed.

Quickstart

This quickstart demonstrates how to initialize the tracker and send a structured event and an unstructured event. It uses the `snowplow_tracker` import path, which is the internal module name for `minimal-snowplow-tracker`. You will need a running Snowplow Collector (e.g., Snowplow Mini) at `COLLECTOR_URL` to receive events.

import os
from snowplow_tracker import Tracker, Emitter
from snowplow_tracker.self_describing_json import SelfDescribingJson

# Replace with your Snowplow Collector endpoint
COLLECTOR_URL = os.environ.get('SNOWPLOW_COLLECTOR_URL', 'http://localhost:9090')

# Initialize an emitter to send events to the collector
emitter = Emitter(COLLECTOR_URL)

# Initialize the tracker with a namespace and application ID
tracker = Tracker(emitters=[emitter], namespace='my_app_namespace', app_id='my-python-app')

# Track a structured event
tracker.track_struct_event(
    category='example_category',
    action='example_action',
    label='example_label',
    property='example_property',
    value=1.0
)

# Track an unstructured event with a self-describing JSON schema
example_schema = 'iglu:com.example_company/example_event/jsonschema/1-0-0'
example_data = {
    'event_detail': 'This is an unstructured event',
    'session_id': 'abc-123'
}
unstructured_event = SelfDescribingJson(example_schema, example_data)
tracker.track_unstruct_event(unstructured_event)

print(f"Events sent to {COLLECTOR_URL} using minimal-snowplow-tracker.")
# In a real application, you might want to gracefully close the emitter or ensure all events are sent.
# For simple scripts, events are often sent synchronously or on program exit.