Install & Compatibility
Where this runs
tested against v0.0.10 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.600s · 22.1MB
glibcpy 3.10–3.95 runs
installs and imports cleanly · install 2.4s · import 0.532s · 23MB
20MB installed
● package 20MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
IterativeTelemetryLogger
✓ from iterative_telemetry import IterativeTelemetryLogger
✗ from iterative_telemetry.logger import IterativeTelemetryLogger
Initialize the IterativeTelemetryLogger with your tool's name and send custom events. Telemetry can be globally disabled by setting the `ITERATIVE_DO_NOT_TRACK=1` environment variable.
import os
from iterative_telemetry.logger import IterativeTelemetryLogger
# Instantiate the logger with your tool's name
# Telemetry can be disabled by setting ITERATIVE_DO_NOT_TRACK=1 in environment variables
logger = IterativeTelemetryLogger(tool_name="my_awesome_tool")
# Send a simple event
logger.send_event("tool_started", {"version": "1.0.0", "mode": "cli"})
# Send an event only once per user/tool instance (e.g., for first-time setup)
logger.send_event_once("first_run_event")
print("Telemetry events sent (or skipped if ITERATIVE_DO_NOT_TRACK is set).")
Debug
Known issues
gotchaTelemetry can be entirely disabled by setting the environment variable `ITERATIVE_DO_NOT_TRACK=1`. This is a crucial user control for privacy.fixEnsure users are aware of the `ITERATIVE_DO_NOT_TRACK` environment variable to opt-out of telemetry collection.
affects: All versions
gotchaPrior to version 0.0.10, telemetry exception handling in daemon mode was fixed. Older versions may have experienced silent failures or unhandled exceptions in long-running background processes.fixUpgrade to version 0.0.10 or newer to ensure robust exception handling in daemonized applications.
affects: <0.0.10
gotchaBefore version 0.0.8, the library might have failed if the GitHub CLI was expected (e.g., for user ID inference) but not present on the system, leading to unexpected errors.fixUpgrade to version 0.0.8 or newer to include exception handling for missing GitHub CLI.
affects: <0.0.8
gotchaThe library is currently in 'Beta' development status (4 - Beta). While stable for its current use cases, the API or internal mechanisms might still undergo changes in future minor or major releases.fixBe aware that as a beta project, API surface or behavior may change in future versions. Review changelogs carefully when upgrading.
affects: All 0.0.x versions
Upgrade
Version history
0.0.10latest on PyPI · released Feb 11, 2025
Audit
Dependencies
pythonrequiredRequires Python 3.8 or higher.