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.1.0a147.tar.gz (13.2 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.1.0a147-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file klyne-0.1.0a147.tar.gz.

File metadata

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

File hashes

Hashes for klyne-0.1.0a147.tar.gz
Algorithm Hash digest
SHA256 ba861db49b9991fc169ecc1cefda0f81033def351d52eafa8957fc7cd4e190b3
MD5 6269a6e9360f44c5a914b896b501e282
BLAKE2b-256 605c34d02379e6e2d294fa7e9a91f08bbaa6127e1f0a6af46fa2a57858715798

See more details on using hashes here.

Provenance

The following attestation bundles were made for klyne-0.1.0a147.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.1.0a147-py3-none-any.whl.

File metadata

  • Download URL: klyne-0.1.0a147-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.1.0a147-py3-none-any.whl
Algorithm Hash digest
SHA256 6a6a76de87d8332491492f59b341f00588f1042dd113f742e2302ef339266048
MD5 e0f5288c9f15ed8df8b4946f683582c1
BLAKE2b-256 522f0a14d12684393f15cfbf5b46f50674b187c062a47b712f9ac0940a158158

See more details on using hashes here.

Provenance

The following attestation bundles were made for klyne-0.1.0a147-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