scarf-py

A Python client for sending telemetry events to Scarf using JSON payloads.

Installation

pip install scarf-sdk

Usage

from scarf import ScarfEventLogger

# Initialize with required endpoint URL
logger = ScarfEventLogger(
    endpoint_url="https://your-scarf-endpoint.com",
    timeout=5.0  # Optional: Set default timeout in seconds (default: 3.0)
)

# Send an event with properties
success = logger.log_event({
    "event": "package_download",
    "package": "scarf",
    "details": {
        "version": "1.0.0",
        "platforms": ["linux", "macos"]
    }
})

# Send an event with a custom timeout
success = logger.log_event(
    properties={"event": "custom_event"},
    timeout=1.0  # Override default timeout for this call
)

# Empty properties are allowed
success = logger.log_event({})

Configuration

The client can be configured through environment variables:

• DO_NOT_TRACK=1: Disable analytics
• SCARF_NO_ANALYTICS=1: Disable analytics (alternative)
• SCARF_VERBOSE=1: Enable verbose logging

Features

• Simple API for sending telemetry events
• JSON payloads (supports nested data)
• Environment variable configuration
• Configurable timeouts (default: 3 seconds)
• Respects user Do Not Track settings
• Verbose logging mode for debugging

Development

1. Clone the repository
2. Install development dependencies:

   pip install -e ".[dev]"
   

3. Run tests:

   pytest
   

Publishing

To publish a new version:

1. Update version in setup.py and pyproject.toml
2. Create and push a new tag:

   git tag v0.1.0
   git push origin v0.1.0
   

The CI workflow will automatically build and publish to PyPI when a new version tag is pushed.

License

Apache 2.0