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 analyticsSCARF_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
- Clone the repository
- Install development dependencies:
pip install -e ".[dev]"
- Run tests:
pytest
Publishing
To publish a new version:
- Update version in
setup.pyandpyproject.toml - 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
Metadata
Release files for scarf-sdk 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| scarf_sdk-0.2.1.tar.gz | 11.0 kB | Without provenance | Details for scarf_sdk-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| scarf_sdk-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for scarf_sdk-0.2.1-py3-none-any.whl |
Total release size: 19.9 kB
Release files / scarf_sdk-0.2.1.tar.gz
| Download URL | scarf_sdk-0.2.1.tar.gz |
|---|---|
| Size | 11.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bac1c41b274659dd6a1653cb61dddb0c222677548f5e6ce2b22baa70a643eb13
|
|
BLAKE2b-256 checksum How to use checksums |
ab56434f4171cffcab2d463dbb2bda20905f748a06a8fde7239e72f4fca89e02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Release files / scarf_sdk-0.2.1-py3-none-any.whl
| Download URL | scarf_sdk-0.2.1-py3-none-any.whl |
|---|---|
| Size | 8.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eaaec3182ea4faceab3a1e0b260318c3f1e432273be03810e09aa807d0939431
|
|
BLAKE2b-256 checksum How to use checksums |
12df1e58161731f1be1bf97122296677862290ee0955392f7e71a4c476f0bf9f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Security for scarf-sdk 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.