Merge branch 'release/1.0.0'

Author: Jack-Keene

.github/workflows/ci.yml

@@ -13,18 +13,6 @@ jobs:
     strategy:
       matrix:
         python-version: [3.6, 3.7, 3.8, 3.9, "3.10", "3.11"]
-        extras-required: [".", ".[redis]"]
-
-    services:
-      redis:
-        image: redis
-        options: >-
-          --health-cmd "redis-cli ping"
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          - 6379:6379
 
     steps:
     - name: Checkout
@@ -42,7 +30,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade "${{ env.pip_v }}" setuptools wheel
-        python -m pip install -e ${{ matrix.extras-required }}
+        python -m pip install -e .
         python -m pip install -r requirements-test.txt
 
     - name: Build
@@ -59,6 +47,12 @@ jobs:
         cd tracker_api_example
         python app.py "localhost:9090"
 
+    - name: Snowplow Demo
+      run: |
+        cd examples
+        cd snowplow_api_example
+        python snowplow_app.py "localhost:9090"
+
     - name: Coveralls
       uses: AndreMiras/coveralls-python-action@develop
       with:

CHANGES.txt

@@ -1,3 +1,12 @@
+Version 1.0.0 (2023-06-16)
+--------------------------
+Remove Redis and Celery Emitters (#335)
+Make tracker namespace mandatory (#337) 
+Track function to return event_id (#338) 
+Fix namespace assignment in Snowplow API (#341) 
+Refactor track_xxx() methods (#343) 
+Update payload builder to combine event subjects (#347) 
+
 Version 0.15.0 (2023-04-19)
 ---------------------------
 Use Requests Session for sending eventss (#221)

docs/source/conf.py

@@ -28,7 +28,7 @@
 author = 'Alex Dean, Paul Boocock, Matus Tomlein, Jack Keene'
 
 # The full version, including alpha/beta/rc tags
-release = "0.15"
+release = "1.0.0"
 
 
 # -- General configuration ---------------------------------------------------

examples/redis_example/redis_app.py

@@ -1,4 +1,12 @@
-from snowplow_tracker import Tracker
+from snowplow_tracker import (
+    Tracker,
+    ScreenView,
+    PagePing,
+    PageView,
+    SelfDescribing,
+    StructuredEvent,
+    SelfDescribingJson,
+)
 from snowplow_tracker.typing import PayloadDict
 import json
 import redis
@@ -49,11 +57,30 @@ def sync_flush(self) -> None:
 def main():
     emitter = RedisEmitter()
 
-    t = Tracker(emitter)
+    t = Tracker(namespace="snowplow_tracker", emitters=emitter)
 
-    t.track_page_view("https://www.snowplow.io", "Homepage")
-    t.track_page_ping("https://www.snowplow.io", "Homepage")
-    t.track_link_click("https://www.snowplow.io")
+    page_view = PageView(page_url="https://www.snowplow.io", page_title="Homepage")
+    t.track(page_view)
+
+    page_ping = PagePing(page_url="https://www.snowplow.io", page_title="Homepage")
+    t.track(page_ping)
+
+    link_click = SelfDescribing(
+        SelfDescribingJson(
+            "iglu:com.snowplowanalytics.snowplow/link_click/jsonschema/1-0-1",
+            {"targetUrl": "https://www.snowplow.io"},
+        )
+    )
+    t.track(link_click)
+
+    id = t.get_uuid()
+    screen_view = ScreenView(id_=id, name="name")
+    t.track(screen_view)
+
+    struct_event = StructuredEvent(
+        category="shop", action="add-to-basket", property_="pcs", value=2
+    )
+    t.track(struct_event)
 
 
 if __name__ == "__main__":

examples/snowplow_api_example/snowplow_app.py

@@ -5,6 +5,11 @@
     Subject,
     TrackerConfiguration,
     SelfDescribingJson,
+    PagePing,
+    PageView,
+    ScreenView,
+    SelfDescribing,
+    StructuredEvent,
 )
 
 
@@ -15,11 +20,12 @@ def get_url_from_args():
 
 
 def main():
-
     collector_url = get_url_from_args()
     # Configure Emitter
     custom_retry_codes = {500: False, 401: True}
-    emitter_config = EmitterConfiguration(batch_size=5, custom_retry_codes=custom_retry_codes)
+    emitter_config = EmitterConfiguration(
+        batch_size=5, custom_retry_codes=custom_retry_codes
+    )
 
     # Configure Tracker
     tracker_config = TrackerConfiguration(encode_base64=True)
@@ -39,19 +45,28 @@ def main():
 
     tracker = Snowplow.get_tracker("ns")
 
-    tracker.track_page_view("https://www.snowplow.io", "Homepage")
-    tracker.track_page_ping("https://www.snowplow.io", "Homepage")
-    tracker.track_link_click("https://www.snowplow.io/about")
-    tracker.track_page_view("https://www.snowplow.io/about", "About")
+    page_view = PageView(page_url="https://www.snowplow.io", page_title="Homepage")
+    tracker.track(page_view)
+
+    page_ping = PagePing(page_url="https://www.snowplow.io", page_title="Homepage")
+    tracker.track(page_ping)
 
-    tracker.track_self_describing_event(
+    link_click = SelfDescribing(
         SelfDescribingJson(
             "iglu:com.snowplowanalytics.snowplow/link_click/jsonschema/1-0-1",
-            {"targetUrl": "example.com"},
+            {"targetUrl": "https://www.snowplow.io"},
         )
     )
-    tracker.track_struct_event("shop", "add-to-basket", None, "pcs", 2)
+    tracker.track(link_click)
 
+    id = tracker.get_uuid()
+    screen_view = ScreenView(id_=id, name="name")
+    tracker.track(screen_view)
+
+    struct_event = StructuredEvent(
+        category="shop", action="add-to-basket", property_="pcs", value=2
+    )
+    tracker.track(struct_event)
     tracker.flush()
 
 

examples/tracker_api_example/app.py

@@ -4,6 +4,11 @@
     Emitter,
     Subject,
     SelfDescribingJson,
+    PageView,
+    PagePing,
+    SelfDescribing,
+    ScreenView,
+    StructuredEvent,
 )
 import sys
 
@@ -22,21 +27,48 @@ def main():
     s = Subject().set_platform("pc")
     s.set_lang("en").set_user_id("test_user")
 
-    t = Tracker(e, s)
+    t = Tracker(namespace="snowplow_tracker", emitters=e, subject=s)
 
     print("Sending events to " + e.endpoint)
 
-    t.track_page_view("https://www.snowplow.io", "Homepage")
-    t.track_page_ping("https://www.snowplow.io", "Homepage")
-    t.track_link_click("https://www.snowplow.io")
+    event_subject = Subject()
+    event_subject.set_color_depth(10)
 
-    t.track_self_describing_event(
+    page_view = PageView(
+        page_url="https://www.snowplow.io",
+        page_title="Homepage",
+        event_subject=event_subject,
+    )
+    t.track(page_view)
+
+    page_ping = PagePing(
+        page_url="https://www.snowplow.io",
+        page_title="Homepage",
+        event_subject=t.subject,
+    )
+    t.track(page_ping)
+
+    link_click = SelfDescribing(
         SelfDescribingJson(
             "iglu:com.snowplowanalytics.snowplow/link_click/jsonschema/1-0-1",
-            {"targetUrl": "example.com"},
-        )
+            {"targetUrl": "https://www.snowplow.io"},
+        ),
+        event_subject=t.subject,
+    )
+    t.track(link_click)
+
+    id = t.get_uuid()
+    screen_view = ScreenView(id_=id, name="name", event_subject=t.subject)
+    t.track(screen_view)
+
+    struct_event = StructuredEvent(
+        category="shop",
+        action="add-to-basket",
+        property_="pcs",
+        value=2,
+        event_subject=t.subject,
     )
-    t.track_struct_event("shop", "add-to-basket", None, "pcs", 2)
+    t.track(struct_event)
     t.flush()
 
 

requirements-test.txt

@@ -5,4 +5,3 @@ httmock==1.4.0
 freezegun==1.1.0
 pytest-cov
 coveralls==3.3.1
-fakeredis==1.7.0