ravn-sdk 0.1.0__tar.gz

ravn_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ravn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ravn_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: ravn-sdk
+Version: 0.1.0
+Summary: Official Python SDK for Ravn — error monitoring and performance tracking
+License: MIT
+Project-URL: Homepage, https://getravn.com
+Project-URL: Documentation, https://docs.getravn.com
+Project-URL: Repository, https://github.com/getravn/ravn-python
+Project-URL: Bug Tracker, https://github.com/getravn/ravn-python/issues
+Keywords: monitoring,error-tracking,observability,logging,apm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28
+Dynamic: license-file
+
+# ravn
+
+The official Python SDK for [Ravn](https://getravn.com) — lightweight error monitoring and performance tracking for Python applications.
+
+## Installation
+
+```bash
+pip install ravn
+```
+
+## Quick Start
+
+```python
+import ravn
+
+ravn.init(api_key="your_api_key_here")
+```
+
+That's it. Ravn will now automatically capture all unhandled exceptions and report them to your dashboard.
+
+## Features
+
+### Automatic Exception Capture
+
+After calling `ravn.init()`, any unhandled exception is automatically sent to Ravn — no try/except needed.
+
+### Manual Exception Capture
+
+```python
+try:
+    risky_operation()
+except Exception as e:
+    ravn.capture_exception(e, metadata={"user_id": 42})
+```
+
+### Log Messages
+
+```python
+ravn.capture_message("Payment processed", level="info", metadata={"amount": 99.99})
+```
+
+Supported levels: `info`, `warning`, `error`.
+
+### Performance Monitoring
+
+```python
+@ravn.measure
+def slow_database_query():
+    ...
+```
+
+Functions decorated with `@ravn.measure` will automatically send a `warning` event to Ravn if they exceed `slow_threshold_ms` (default: 1000ms).
+
+## Configuration
+
+```python
+ravn.init(
+    api_key="your_api_key_here",
+    api_url="https://app.getravn.com/api/v1/ingest",  # optional override
+    slow_threshold_ms=500,  # warn if functions take longer than 500ms
+)
+```
+
+## Requirements
+
+- Python >= 3.8
+- `requests >= 2.28`
+
+## License
+
+MIT

ravn_sdk-0.1.0/README.md

@@ -0,0 +1,71 @@
+# ravn
+
+The official Python SDK for [Ravn](https://getravn.com) — lightweight error monitoring and performance tracking for Python applications.
+
+## Installation
+
+```bash
+pip install ravn
+```
+
+## Quick Start
+
+```python
+import ravn
+
+ravn.init(api_key="your_api_key_here")
+```
+
+That's it. Ravn will now automatically capture all unhandled exceptions and report them to your dashboard.
+
+## Features
+
+### Automatic Exception Capture
+
+After calling `ravn.init()`, any unhandled exception is automatically sent to Ravn — no try/except needed.
+
+### Manual Exception Capture
+
+```python
+try:
+    risky_operation()
+except Exception as e:
+    ravn.capture_exception(e, metadata={"user_id": 42})
+```
+
+### Log Messages
+
+```python
+ravn.capture_message("Payment processed", level="info", metadata={"amount": 99.99})
+```
+
+Supported levels: `info`, `warning`, `error`.
+
+### Performance Monitoring
+
+```python
+@ravn.measure
+def slow_database_query():
+    ...
+```
+
+Functions decorated with `@ravn.measure` will automatically send a `warning` event to Ravn if they exceed `slow_threshold_ms` (default: 1000ms).
+
+## Configuration
+
+```python
+ravn.init(
+    api_key="your_api_key_here",
+    api_url="https://app.getravn.com/api/v1/ingest",  # optional override
+    slow_threshold_ms=500,  # warn if functions take longer than 500ms
+)
+```
+
+## Requirements
+
+- Python >= 3.8
+- `requests >= 2.28`
+
+## License
+
+MIT

ravn_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ravn-sdk"
+version = "0.1.0"
+description = "Official Python SDK for Ravn — error monitoring and performance tracking"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.8"
+dependencies = ["requests>=2.28"]
+keywords = ["monitoring", "error-tracking", "observability", "logging", "apm"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Monitoring",
+    "Topic :: System :: Logging",
+]
+
+[project.urls]
+Homepage = "https://getravn.com"
+Documentation = "https://docs.getravn.com"
+Repository = "https://github.com/getravn/ravn-python"
+"Bug Tracker" = "https://github.com/getravn/ravn-python/issues"
+
+[tool.setuptools.packages.find]
+where = ["."]

ravn_sdk-0.1.0/ravn/__init__.py

@@ -0,0 +1,145 @@
+"""Ravn — Error monitoring and performance tracking SDK for Python."""
+
+import atexit
+import functools
+import os
+import platform
+import sys
+import time
+import traceback
+from concurrent.futures import ThreadPoolExecutor
+from typing import Callable, Optional
+
+import requests
+
+__version__ = "0.1.0"
+__all__ = ["init", "capture_exception", "capture_message", "measure"]
+
+_DEFAULT_API_URL = "https://app.getravn.com/api/v1/ingest"
+
+_CONFIG: dict = {
+    "api_key": None,
+    "api_url": _DEFAULT_API_URL,
+    "enabled": False,
+    "slow_threshold_ms": 1000,
+}
+
+_executor = ThreadPoolExecutor(max_workers=1, thread_name_prefix="ravn-worker")
+atexit.register(lambda: _executor.shutdown(wait=True))
+
+
+def _send_payload(payload: dict) -> None:
+    headers = {
+        "Content-Type": "application/json",
+        "x-api-key": _CONFIG["api_key"],
+    }
+    try:
+        requests.post(_CONFIG["api_url"], json=payload, headers=headers, timeout=3)
+    except Exception:
+        pass
+
+
+def _base_metadata(extra: Optional[dict] = None) -> dict:
+    meta: dict = {
+        "sdk_version": __version__,
+        "python_version": platform.python_version(),
+        "platform": platform.system(),
+        "cwd": os.getcwd(),
+    }
+    if extra:
+        meta.update(extra)
+    return meta
+
+
+def capture_exception(exc: Exception, metadata: Optional[dict] = None) -> None:
+    """Capture and report an exception to Ravn."""
+    if not _CONFIG["enabled"]:
+        return
+    try:
+        tb = "".join(traceback.format_exception(type(exc), exc, exc.__traceback__))
+        payload = {
+            "message": f"{type(exc).__name__}: {exc}",
+            "level": "error",
+            "metadata": _base_metadata({"stack_trace": tb, **(metadata or {})}),
+        }
+        _executor.submit(_send_payload, payload)
+    except Exception:
+        pass
+
+
+def capture_message(
+    message: str, level: str = "info", metadata: Optional[dict] = None
+) -> None:
+    """Send an arbitrary log message to Ravn."""
+    if not _CONFIG["enabled"]:
+        return
+    try:
+        payload = {
+            "message": message,
+            "level": level,
+            "metadata": _base_metadata(metadata),
+        }
+        _executor.submit(_send_payload, payload)
+    except Exception:
+        pass
+
+
+def _global_exception_handler(exc_type, exc_value, exc_traceback) -> None:
+    if issubclass(exc_type, KeyboardInterrupt):
+        sys.__excepthook__(exc_type, exc_value, exc_traceback)
+        return
+    capture_exception(exc_value, metadata={"mechanism": "unhandled_exception"})
+    sys.__excepthook__(exc_type, exc_value, exc_traceback)
+
+
+def init(
+    api_key: str,
+    api_url: Optional[str] = None,
+    slow_threshold_ms: int = 1000,
+) -> None:
+    """Initialize the Ravn SDK.
+
+    Args:
+        api_key: Your Ravn project API key.
+        api_url: Override the ingest endpoint (default: Ravn cloud).
+        slow_threshold_ms: Performance alert threshold in milliseconds (default: 1000).
+    """
+    _CONFIG["api_key"] = api_key
+    _CONFIG["enabled"] = True
+    _CONFIG["slow_threshold_ms"] = slow_threshold_ms
+    if api_url:
+        _CONFIG["api_url"] = api_url
+    sys.excepthook = _global_exception_handler
+    print(f"[Ravn] Initialized (key: {api_key[:8]}…)")
+
+
+def measure(func: Callable) -> Callable:
+    """Decorator that reports slow function calls to Ravn.
+
+    Usage:
+        @ravn.measure
+        def my_function():
+            ...
+    """
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        if not _CONFIG["enabled"]:
+            return func(*args, **kwargs)
+        start = time.perf_counter()
+        try:
+            return func(*args, **kwargs)
+        finally:
+            duration_ms = (time.perf_counter() - start) * 1000
+            if duration_ms > _CONFIG["slow_threshold_ms"]:
+                capture_message(
+                    f"Slow function: '{func.__name__}' took {duration_ms:.0f}ms",
+                    level="warning",
+                    metadata={
+                        "function": func.__name__,
+                        "module": func.__module__,
+                        "duration_ms": round(duration_ms, 2),
+                        "threshold_ms": _CONFIG["slow_threshold_ms"],
+                    },
+                )
+
+    return wrapper

ravn_sdk-0.1.0/ravn_sdk.egg-info/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.4
+Name: ravn-sdk
+Version: 0.1.0
+Summary: Official Python SDK for Ravn — error monitoring and performance tracking
+License: MIT
+Project-URL: Homepage, https://getravn.com
+Project-URL: Documentation, https://docs.getravn.com
+Project-URL: Repository, https://github.com/getravn/ravn-python
+Project-URL: Bug Tracker, https://github.com/getravn/ravn-python/issues
+Keywords: monitoring,error-tracking,observability,logging,apm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28
+Dynamic: license-file
+
+# ravn
+
+The official Python SDK for [Ravn](https://getravn.com) — lightweight error monitoring and performance tracking for Python applications.
+
+## Installation
+
+```bash
+pip install ravn
+```
+
+## Quick Start
+
+```python
+import ravn
+
+ravn.init(api_key="your_api_key_here")
+```
+
+That's it. Ravn will now automatically capture all unhandled exceptions and report them to your dashboard.
+
+## Features
+
+### Automatic Exception Capture
+
+After calling `ravn.init()`, any unhandled exception is automatically sent to Ravn — no try/except needed.
+
+### Manual Exception Capture
+
+```python
+try:
+    risky_operation()
+except Exception as e:
+    ravn.capture_exception(e, metadata={"user_id": 42})
+```
+
+### Log Messages
+
+```python
+ravn.capture_message("Payment processed", level="info", metadata={"amount": 99.99})
+```
+
+Supported levels: `info`, `warning`, `error`.
+
+### Performance Monitoring
+
+```python
+@ravn.measure
+def slow_database_query():
+    ...
+```
+
+Functions decorated with `@ravn.measure` will automatically send a `warning` event to Ravn if they exceed `slow_threshold_ms` (default: 1000ms).
+
+## Configuration
+
+```python
+ravn.init(
+    api_key="your_api_key_here",
+    api_url="https://app.getravn.com/api/v1/ingest",  # optional override
+    slow_threshold_ms=500,  # warn if functions take longer than 500ms
+)
+```
+
+## Requirements
+
+- Python >= 3.8
+- `requests >= 2.28`
+
+## License
+
+MIT

ravn_sdk-0.1.0/ravn_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+setup.py
+ravn/__init__.py
+ravn_sdk.egg-info/PKG-INFO
+ravn_sdk.egg-info/SOURCES.txt
+ravn_sdk.egg-info/dependency_links.txt
+ravn_sdk.egg-info/requires.txt
+ravn_sdk.egg-info/top_level.txt

ravn_sdk-0.1.0/ravn_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ravn_sdk-0.1.0/ravn_sdk.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.28

ravn_sdk-0.1.0/ravn_sdk.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+ravn

ravn_sdk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ravn_sdk-0.1.0/setup.py

@@ -0,0 +1,5 @@
+# All packaging metadata lives in pyproject.toml.
+# This file is kept only for backwards compatibility with older tooling.
+from setuptools import setup
+
+setup()