Skip to main content

Lightweight Python package analytics SDK

Project description

Klyne Python SDK

PyPI version Python Support License: MIT

Lightweight Python package analytics SDK for Klyne. Track package usage, Python version adoption, OS distribution, and more with minimal overhead.

Features

  • =� Lightweight: Zero dependencies, uses only Python standard library
  • Non-blocking: Asynchronous data transmission in background threads
  • = Privacy-first: No PII collection, only aggregated usage metrics
  • =� Robust: Graceful error handling and automatic retries
  • =� Rich insights: Python versions, OS distribution, environment detection
  • <� Simple API: One-line integration with sensible defaults

Installation

pip install klyne

Quick Start 💨

import klyne

# Initialize once in your package
klyne.init(
    api_key="klyne_your_api_key_here",
    project="your-package-name",
    package_version="1.0.0"
)

# That's it! Analytics are automatically collected

What Gets Tracked

The SDK automatically collects:

  • Python Environment: Version, implementation (CPython/PyPy)
  • Operating System: Type, version, architecture
  • Installation Context: pip/conda, virtual environment detection
  • Hardware: CPU count, memory (rounded for privacy)
  • Package Info: Name, version, entry points used

No personally identifiable information is collected.

Advanced Usage

Custom Event Tracking (coming soon)

import klyne

# Track specific functions or features
klyne.track_event(
    entry_point="advanced_feature",
    extra_data={"mode": "premium", "user_type": "enterprise"}
)

Configuration Options

import klyne

klyne.init(
    api_key="klyne_your_api_key_here",
    project="your-package-name",
    package_version="1.0.0",
    base_url="https://www.klyne.dev",  # Default API URL
    enabled=True,                      # Enable/disable analytics
    debug=False                        # Debug logging
)

Environment-based Control

import os
import klyne

# Disable in development
enabled = os.getenv("ENVIRONMENT") == "production"

klyne.init(
    api_key=os.getenv("KLYNE_API_KEY"),
    project="your-package-name",
    enabled=enabled
)

Manual Control

import klyne

# Disable analytics
klyne.disable()

# Re-enable analytics
klyne.enable()

# Check status
if klyne.is_enabled():
    print("Analytics are active")

# Flush pending events (useful for short-lived scripts)
klyne.flush(timeout=5.0)

Requirements

  • Python 3.7+
  • No external dependencies
  • Internet connection (for sending analytics)

License

MIT License


Get your free API key at klyne.dev

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

klyne-0.2.0.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

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

klyne-0.2.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file klyne-0.2.0.tar.gz.

File metadata

  • Download URL: klyne-0.2.0.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for klyne-0.2.0.tar.gz
Algorithm Hash digest
SHA256 bc6f31e119e846767c5a5d2357edfdd741e3a430c86e9da022ce027a8eae057c
MD5 3ca903aca76e04a0c24ab5fb5ddb9cbd
BLAKE2b-256 059f0fd7b800cb1a390dc5d590a9bf096456706cdd724140b044bea3a914dacc

See more details on using hashes here.

Provenance

The following attestation bundles were made for klyne-0.2.0.tar.gz:

Publisher: publish-sdk.yml on psincraian/klyne

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file klyne-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: klyne-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for klyne-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54220db7b8412c2c31c59219f83306e842d5e0b40d22c909baccee26b939a0fe
MD5 54faf7909a0c3aed7c3efd8e3af91c6a
BLAKE2b-256 bce3aff5e531584b27892c9566c1086ec5803b53689cd40dcf96f9c4e3860b7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for klyne-0.2.0-py3-none-any.whl:

Publisher: publish-sdk.yml on psincraian/klyne

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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