altissimo-mixpanel 0.1.0__tar.gz

altissimo_mixpanel-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Altissimo HQ
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

altissimo_mixpanel-0.1.0/PKG-INFO

@@ -0,0 +1,248 @@
+Metadata-Version: 2.4
+Name: altissimo-mixpanel
+Version: 0.1.0
+Summary: Reusable Mixpanel analytics client for Altissimo projects
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: mixpanel,analytics,altissimo
+Author: Altissimo HQ
+Requires-Python: >=3.11
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Provides-Extra: mixpanel
+Requires-Dist: mixpanel (>=4.0) ; extra == "mixpanel"
+Project-URL: Changelog, https://github.com/altissimo-hq/mixpanel-python/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://github.com/altissimo-hq/mixpanel-python
+Project-URL: Issues, https://github.com/altissimo-hq/mixpanel-python/issues
+Project-URL: Repository, https://github.com/altissimo-hq/mixpanel-python
+Description-Content-Type: text/markdown
+
+# altissimo-mixpanel
+
+Reusable, typed Mixpanel analytics client for Altissimo projects.
+
+## Features
+
+- **Typed API** — full type annotations for all operations
+- **Lazy SDK import** — `mixpanel` is imported only when needed, zero import-time side effects
+- **Disabled mode** — no-op all calls when analytics is turned off or isn't configured
+- **Error handling** — swallow-and-log by default, configurable via `on_error`
+- **Protocol for DI** — `MixpanelClientProtocol` for dependency injection
+- **Test helpers** — `FakeMixpanelClient` records all calls in-memory
+- **Optional dependency** — works without `mixpanel` installed (fails gracefully)
+
+## Installation
+
+Published on PyPI as [`altissimo-mixpanel`](https://pypi.org/project/altissimo-mixpanel/);
+the import name is `altissimo.mixpanel`.
+
+```bash
+# With the Mixpanel SDK (recommended)
+pip install "altissimo-mixpanel[mixpanel]"
+
+# Without the SDK (for type checking / protocol-only usage)
+pip install altissimo-mixpanel
+```
+
+## Quick Start
+
+### Using `from_env()`
+
+```python
+from altissimo.mixpanel import MixpanelClient
+
+# Reads MIXPANEL_TOKEN from environment
+# Missing token → disabled mode, with a warning (see Disabled Mode)
+client = MixpanelClient.from_env()
+
+# Track an event
+client.track("user-123", "Page Viewed", properties={"page": "/home"})
+
+# Set user profile properties
+client.people_set("user-123", {"$name": "Jane Doe", "$email": "jane@example.com"})
+```
+
+### Direct Construction
+
+```python
+client = MixpanelClient(
+    token="your-project-token",
+    enabled=True,
+    on_error="log",  # "log" | "raise" | "ignore"
+)
+```
+
+### Disabled Mode
+
+```python
+# Explicitly disabled
+client = MixpanelClient(token="...", enabled=False)
+client.track("user-123", "Page Viewed")  # silently does nothing
+
+# Via environment variable
+# MIXPANEL_ENABLED=false → disabled
+client = MixpanelClient.from_env()
+
+# Missing token → automatically disabled, and a warning names the variable
+# (no MIXPANEL_TOKEN set)
+client = MixpanelClient.from_env()
+assert not client.enabled
+```
+
+When the token is missing, `from_env()` behaves according to how tracking was
+turned on:
+
+| `enabled` | Missing or empty token |
+| --- | --- |
+| `True` (passed explicitly) | Raises `ValueError` naming the variable |
+| `None` (default; `MIXPANEL_ENABLED` unset or truthy) | Disabled, one warning naming the variable |
+| `False`, or `MIXPANEL_ENABLED` falsey | Disabled, no warning |
+
+Pass `enabled=True` where a deployment must send events, so a missing secret
+fails at startup instead of looking like Mixpanel going quiet. An app that only
+sends events when deployed can pass that condition, e.g.
+`MixpanelClient.from_env(enabled=IS_DEPLOYED)`: quiet locally, an error on a
+deployment missing its token.
+
+### Error Handling
+
+```python
+# Default: catch and log errors (analytics never crashes your app)
+client = MixpanelClient(token="...", on_error="log")
+
+# Raise errors (useful for debugging)
+client = MixpanelClient(token="...", on_error="raise")
+
+# Silently ignore errors
+client = MixpanelClient(token="...", on_error="ignore")
+```
+
+### Custom Consumer
+
+```python
+from mixpanel import BufferedConsumer
+
+# Use a buffered consumer for high-throughput
+client = MixpanelClient(token="...", consumer=BufferedConsumer())
+```
+
+A `BufferedConsumer` only sends when its buffer fills, so flush it before the
+process exits (a Cloud Run instance shutting down, a job or CLI command
+finishing), or the buffered events are lost:
+
+```python
+client.flush()
+
+# Or flush automatically when the block ends, even if it raises:
+with MixpanelClient(token="...", consumer=BufferedConsumer()) as client:
+    client.track("user-123", "Job Finished")
+```
+
+With the default consumer, which sends each message immediately, `flush()`
+does nothing. A failing flush follows `on_error` like every other call.
+
+Any object with `send(endpoint, json_message)` works as a consumer; the
+`MixpanelConsumer` protocol describes it for type checking.
+
+### Threads
+
+One `MixpanelClient` can be shared across threads, such as a module-level
+client in a web app. Each thread gets its own Mixpanel SDK instance and, with
+the default consumer, its own HTTP session: the SDK's `Consumer` and
+`BufferedConsumer` aren't safe to share between threads.
+
+A `consumer=` is a single object every thread shares, so in a threaded app pass
+a `consumer_factory` instead; it's called once per thread:
+
+```python
+from mixpanel import BufferedConsumer, Consumer
+
+# A shorter request timeout, one consumer per thread
+client = MixpanelClient.from_env(consumer_factory=lambda: Consumer(request_timeout=5))
+
+# Buffered, one buffer per thread
+client = MixpanelClient(token="...", consumer_factory=BufferedConsumer)
+```
+
+`flush()` flushes every thread's consumer. Call it when no other thread is
+tracking, such as at shutdown.
+
+### Testing with `FakeMixpanelClient`
+
+```python
+from altissimo.mixpanel import FakeMixpanelClient
+
+def test_order_tracking():
+    fake = FakeMixpanelClient()
+    service = OrderService(mixpanel=fake)
+
+    service.create_order(user_id="user-123", total=99.99)
+
+    assert len(fake.tracked) == 1
+    assert fake.tracked[0][1] == "Order Created"
+    assert fake.tracked[0][2]["total"] == 99.99
+```
+
+### Protocol-Based Dependency Injection
+
+```python
+from altissimo.mixpanel import MixpanelClientProtocol
+
+class OrderService:
+    def __init__(self, mixpanel: MixpanelClientProtocol) -> None:
+        self._mp = mixpanel
+
+    def create_order(self, user_id: str, total: float) -> None:
+        # ... business logic ...
+        self._mp.track(user_id, "Order Created", properties={"total": total})
+```
+
+## API Reference
+
+### `MixpanelClient`
+
+| Method | Description |
+|---|---|
+| `track(distinct_id, event_name, *, properties?, meta?)` | Track an event |
+| `people_set(distinct_id, properties, *, meta?)` | Set user profile properties |
+| `people_set_once(distinct_id, properties, *, meta?)` | Set properties only if not set |
+| `people_increment(distinct_id, properties, *, meta?)` | Increment numeric properties |
+| `people_union(distinct_id, properties, *, meta?)` | Append to list properties |
+| `people_unset(distinct_id, property_names, *, meta?)` | Remove properties |
+| `alias(alias_id, original_id, *, meta?)` | Create an identity alias |
+
+### Environment Variables
+
+| Variable | Default | Description |
+|---|---|---|
+| `MIXPANEL_TOKEN` | — | Mixpanel project token |
+| `MIXPANEL_ENABLED` | `true` | Set to `false`/`0`/`no` to disable |
+
+## Development
+
+```bash
+# Install dependencies
+poetry sync
+
+# Run tests
+poetry run pytest
+
+# Run tests with coverage
+poetry run pytest --cov=altissimo --cov-report=term-missing
+
+# Lint
+poetry run ruff check .
+
+# Format
+poetry run ruff format .
+```
+
+## License
+
+[Apache-2.0](LICENSE)
+

altissimo_mixpanel-0.1.0/README.md

@@ -0,0 +1,223 @@
+# altissimo-mixpanel
+
+Reusable, typed Mixpanel analytics client for Altissimo projects.
+
+## Features
+
+- **Typed API** — full type annotations for all operations
+- **Lazy SDK import** — `mixpanel` is imported only when needed, zero import-time side effects
+- **Disabled mode** — no-op all calls when analytics is turned off or isn't configured
+- **Error handling** — swallow-and-log by default, configurable via `on_error`
+- **Protocol for DI** — `MixpanelClientProtocol` for dependency injection
+- **Test helpers** — `FakeMixpanelClient` records all calls in-memory
+- **Optional dependency** — works without `mixpanel` installed (fails gracefully)
+
+## Installation
+
+Published on PyPI as [`altissimo-mixpanel`](https://pypi.org/project/altissimo-mixpanel/);
+the import name is `altissimo.mixpanel`.
+
+```bash
+# With the Mixpanel SDK (recommended)
+pip install "altissimo-mixpanel[mixpanel]"
+
+# Without the SDK (for type checking / protocol-only usage)
+pip install altissimo-mixpanel
+```
+
+## Quick Start
+
+### Using `from_env()`
+
+```python
+from altissimo.mixpanel import MixpanelClient
+
+# Reads MIXPANEL_TOKEN from environment
+# Missing token → disabled mode, with a warning (see Disabled Mode)
+client = MixpanelClient.from_env()
+
+# Track an event
+client.track("user-123", "Page Viewed", properties={"page": "/home"})
+
+# Set user profile properties
+client.people_set("user-123", {"$name": "Jane Doe", "$email": "jane@example.com"})
+```
+
+### Direct Construction
+
+```python
+client = MixpanelClient(
+    token="your-project-token",
+    enabled=True,
+    on_error="log",  # "log" | "raise" | "ignore"
+)
+```
+
+### Disabled Mode
+
+```python
+# Explicitly disabled
+client = MixpanelClient(token="...", enabled=False)
+client.track("user-123", "Page Viewed")  # silently does nothing
+
+# Via environment variable
+# MIXPANEL_ENABLED=false → disabled
+client = MixpanelClient.from_env()
+
+# Missing token → automatically disabled, and a warning names the variable
+# (no MIXPANEL_TOKEN set)
+client = MixpanelClient.from_env()
+assert not client.enabled
+```
+
+When the token is missing, `from_env()` behaves according to how tracking was
+turned on:
+
+| `enabled` | Missing or empty token |
+| --- | --- |
+| `True` (passed explicitly) | Raises `ValueError` naming the variable |
+| `None` (default; `MIXPANEL_ENABLED` unset or truthy) | Disabled, one warning naming the variable |
+| `False`, or `MIXPANEL_ENABLED` falsey | Disabled, no warning |
+
+Pass `enabled=True` where a deployment must send events, so a missing secret
+fails at startup instead of looking like Mixpanel going quiet. An app that only
+sends events when deployed can pass that condition, e.g.
+`MixpanelClient.from_env(enabled=IS_DEPLOYED)`: quiet locally, an error on a
+deployment missing its token.
+
+### Error Handling
+
+```python
+# Default: catch and log errors (analytics never crashes your app)
+client = MixpanelClient(token="...", on_error="log")
+
+# Raise errors (useful for debugging)
+client = MixpanelClient(token="...", on_error="raise")
+
+# Silently ignore errors
+client = MixpanelClient(token="...", on_error="ignore")
+```
+
+### Custom Consumer
+
+```python
+from mixpanel import BufferedConsumer
+
+# Use a buffered consumer for high-throughput
+client = MixpanelClient(token="...", consumer=BufferedConsumer())
+```
+
+A `BufferedConsumer` only sends when its buffer fills, so flush it before the
+process exits (a Cloud Run instance shutting down, a job or CLI command
+finishing), or the buffered events are lost:
+
+```python
+client.flush()
+
+# Or flush automatically when the block ends, even if it raises:
+with MixpanelClient(token="...", consumer=BufferedConsumer()) as client:
+    client.track("user-123", "Job Finished")
+```
+
+With the default consumer, which sends each message immediately, `flush()`
+does nothing. A failing flush follows `on_error` like every other call.
+
+Any object with `send(endpoint, json_message)` works as a consumer; the
+`MixpanelConsumer` protocol describes it for type checking.
+
+### Threads
+
+One `MixpanelClient` can be shared across threads, such as a module-level
+client in a web app. Each thread gets its own Mixpanel SDK instance and, with
+the default consumer, its own HTTP session: the SDK's `Consumer` and
+`BufferedConsumer` aren't safe to share between threads.
+
+A `consumer=` is a single object every thread shares, so in a threaded app pass
+a `consumer_factory` instead; it's called once per thread:
+
+```python
+from mixpanel import BufferedConsumer, Consumer
+
+# A shorter request timeout, one consumer per thread
+client = MixpanelClient.from_env(consumer_factory=lambda: Consumer(request_timeout=5))
+
+# Buffered, one buffer per thread
+client = MixpanelClient(token="...", consumer_factory=BufferedConsumer)
+```
+
+`flush()` flushes every thread's consumer. Call it when no other thread is
+tracking, such as at shutdown.
+
+### Testing with `FakeMixpanelClient`
+
+```python
+from altissimo.mixpanel import FakeMixpanelClient
+
+def test_order_tracking():
+    fake = FakeMixpanelClient()
+    service = OrderService(mixpanel=fake)
+
+    service.create_order(user_id="user-123", total=99.99)
+
+    assert len(fake.tracked) == 1
+    assert fake.tracked[0][1] == "Order Created"
+    assert fake.tracked[0][2]["total"] == 99.99
+```
+
+### Protocol-Based Dependency Injection
+
+```python
+from altissimo.mixpanel import MixpanelClientProtocol
+
+class OrderService:
+    def __init__(self, mixpanel: MixpanelClientProtocol) -> None:
+        self._mp = mixpanel
+
+    def create_order(self, user_id: str, total: float) -> None:
+        # ... business logic ...
+        self._mp.track(user_id, "Order Created", properties={"total": total})
+```
+
+## API Reference
+
+### `MixpanelClient`
+
+| Method | Description |
+|---|---|
+| `track(distinct_id, event_name, *, properties?, meta?)` | Track an event |
+| `people_set(distinct_id, properties, *, meta?)` | Set user profile properties |
+| `people_set_once(distinct_id, properties, *, meta?)` | Set properties only if not set |
+| `people_increment(distinct_id, properties, *, meta?)` | Increment numeric properties |
+| `people_union(distinct_id, properties, *, meta?)` | Append to list properties |
+| `people_unset(distinct_id, property_names, *, meta?)` | Remove properties |
+| `alias(alias_id, original_id, *, meta?)` | Create an identity alias |
+
+### Environment Variables
+
+| Variable | Default | Description |
+|---|---|---|
+| `MIXPANEL_TOKEN` | — | Mixpanel project token |
+| `MIXPANEL_ENABLED` | `true` | Set to `false`/`0`/`no` to disable |
+
+## Development
+
+```bash
+# Install dependencies
+poetry sync
+
+# Run tests
+poetry run pytest
+
+# Run tests with coverage
+poetry run pytest --cov=altissimo --cov-report=term-missing
+
+# Lint
+poetry run ruff check .
+
+# Format
+poetry run ruff format .
+```
+
+## License
+
+[Apache-2.0](LICENSE)