klyne 0.2.1a7

Lightweight Python package analytics SDK

Klyne Python SDK

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

Track custom events with properties to understand how users interact with your package:

import klyne

# Track user actions
klyne.track('user_login', {
    'user_id': '12345',
    'login_method': 'google'
})

# Track feature usage
klyne.track('feature_used', {
    'feature_name': 'export',
    'file_format': 'csv',
    'rows_exported': 1000
})

# Track errors or issues
klyne.track('error_occurred', {
    'error_type': 'ValidationError',
    'module': 'data_processor'
})

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