Metadata-Version: 2.5
Name: vaka-sdk
Version: 0.3.0
Summary: Python SDK for Vaka: crash reporting, release health, analytics, feature flags and OpenTelemetry export
Project-URL: Homepage, https://vaka.hellsoft.se
Project-URL: Documentation, https://vaka.hellsoft.se/docs/sdk-python
Project-URL: Source, https://github.com/ErikHellman/vaka/tree/main/sdks/python
Project-URL: Issues, https://github.com/ErikHellman/vaka/issues
Author: Erik Hellman
License-Expression: MIT OR Apache-2.0
License-File: LICENSE-APACHE
License-File: LICENSE-MIT
Keywords: analytics,crash-reporting,error-tracking,feature-flags,opentelemetry,vaka
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Framework :: FastAPI
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Bug Tracking
Classifier: Topic :: System :: Monitoring
Classifier: Typing :: Typed
Requires-Python: >=3.9
Provides-Extra: otel
Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.24; extra == 'otel'
Requires-Dist: opentelemetry-sdk>=1.24; extra == 'otel'
Description-Content-Type: text/markdown

# vaka-sdk (Python)

Python SDK for [Vaka](https://github.com/ErikHellman/vaka), the agent-first crash reporting and
analytics service: unhandled exceptions, `logging` errors, breadcrumbs, release health, custom
events and feature flags, plus one-call OpenTelemetry setup for traces and logs.

```sh
pip install vaka-sdk            # errors, sessions, events, flags (no dependencies)
pip install "vaka-sdk[otel]"    # + traces and logs through OpenTelemetry
```

```python
import vaka

vaka.init(key="vk_...", endpoint="https://vaka.example.com", release="2.4.0", service="checkout")

try:
    charge(order)
except PaymentError as e:
    vaka.capture_exception(e)

vaka.track("order_placed", {"plan": "pro"})
```

Framework hooks: `vaka.integrations.django.VakaMiddleware`, `vaka.integrations.flask.init_app(app)`,
`vaka.integrations.asgi.VakaAsgiMiddleware` (FastAPI, Starlette) and
`vaka.integrations.wsgi.VakaWsgiMiddleware`. Traces and logs: `vaka.otel.setup()`.

Full documentation: [docs/sdk-python.md](https://github.com/ErikHellman/vaka/blob/main/docs/sdk-python.md).
Agent-followable install guide: `/docs/install/python` on any Vaka server.

Python 3.9+. Licensed MIT OR Apache-2.0.
