errorgap 0.1.0__tar.gz

errorgap-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+on:
+  push:
+    branches: [main]
+  pull_request:
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest

errorgap-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,17 @@
+name: Release
+on:
+  push:
+    tags: ["v*"]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build && python -m build
+      - uses: pypa/gh-action-pypi-publish@release/v1

errorgap-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+build/
+dist/
+.coverage
+htmlcov/
+.DS_Store
+.env
+.env.*
+!.env.example

errorgap-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Errorgap
+
+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.

errorgap-0.1.0/PKG-INFO

@@ -0,0 +1,163 @@
+Metadata-Version: 2.4
+Name: errorgap
+Version: 0.1.0
+Summary: Python notifier for Errorgap error tracking.
+Project-URL: Homepage, https://github.com/errorgaphq/errorgap-python
+Project-URL: Source, https://github.com/errorgaphq/errorgap-python
+Author: Errorgap
+License: MIT
+License-File: LICENSE
+Keywords: error-tracking,errorgap,exceptions,monitoring
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Bug Tracking
+Requires-Python: >=3.9
+Provides-Extra: dev
+Requires-Dist: django>=4.2; extra == 'dev'
+Requires-Dist: fastapi>=0.100; extra == 'dev'
+Requires-Dist: flask>=2.3; extra == 'dev'
+Requires-Dist: httpx>=0.27; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: starlette>=0.27; extra == 'dev'
+Provides-Extra: django
+Requires-Dist: django>=4.2; extra == 'django'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100; extra == 'fastapi'
+Requires-Dist: starlette>=0.27; extra == 'fastapi'
+Provides-Extra: flask
+Requires-Dist: flask>=2.3; extra == 'flask'
+Description-Content-Type: text/markdown
+
+# errorgap
+
+Python notifier for [Errorgap](https://errorgap.com). Captures exceptions,
+normalizes tracebacks, and ships notices to an Errorgap server. Single
+package covers plain Python, Django, Flask, and FastAPI.
+
+## Install
+
+```sh
+pip install errorgap
+```
+
+For framework integrations:
+
+```sh
+pip install "errorgap[django]"   # or [flask], [fastapi]
+```
+
+Requires Python 3.9+.
+
+## Configure
+
+```python
+import errorgap
+
+errorgap.init(
+    endpoint=...,
+    project_slug=...,
+    api_key=...,
+    environment="production",
+)
+```
+
+`init` reads the same values from `ERRORGAP_ENDPOINT`,
+`ERRORGAP_PROJECT_SLUG`, `ERRORGAP_PROJECT_ID`, and `ERRORGAP_API_KEY` if you
+don't pass them. By default it installs a `sys.excepthook` to catch
+uncaught exceptions in scripts; pass `capture_globals=False` to skip.
+
+## Manual notification
+
+```python
+try:
+    risky()
+except Exception as exc:
+    errorgap.notify(exc, context={"component": "billing"})
+    raise
+```
+
+`notify` returns a `DeliveryResult` (`status`, `body`, `error`, `queued`).
+The SDK never raises.
+
+## Django
+
+Add to `MIDDLEWARE`:
+
+```python
+MIDDLEWARE = [
+    "errorgap.django.ErrorgapMiddleware",
+    # ... your existing middleware ...
+]
+```
+
+## Flask
+
+```python
+from flask import Flask
+from errorgap.flask import init_app
+
+app = Flask(__name__)
+init_app(app)
+```
+
+## FastAPI
+
+```python
+from fastapi import FastAPI
+from errorgap.fastapi import ErrorgapMiddleware
+
+app = FastAPI()
+app.add_middleware(ErrorgapMiddleware)
+```
+
+## Configuration reference
+
+| Argument | Default | Notes |
+|---|---|---|
+| `endpoint` | `ERRORGAP_ENDPOINT` or `http://127.0.0.1:3030` | Base URL, no trailing slash |
+| `project_slug` | `ERRORGAP_PROJECT_SLUG` | **Required** |
+| `project_id` | `ERRORGAP_PROJECT_ID` | Optional, embedded in payload |
+| `api_key` | `ERRORGAP_API_KEY` | Sent as `x-errorgap-project-key` |
+| `environment` | `ERRORGAP_ENVIRONMENT`, `ENV`, or `development` | |
+| `root_directory` | `os.getcwd()` | Used to mark frames as `in_app` |
+| `async_` | `True` | Background-thread delivery |
+| `logger` | `logging.getLogger("errorgap")` | Pass `None` to silence |
+| `filter_keys` | `("password", "token", ...)` | Substring match, case-insensitive |
+| `capture_globals` | `True` | Install `sys.excepthook` |
+
+## Graceful shutdown
+
+```python
+errorgap.flush(timeout=5)     # wait for queued deliveries
+errorgap.shutdown(timeout=5)  # flush + tear down background thread
+```
+
+## Verify
+
+```sh
+curl -sS -X POST "$ERRORGAP_ENDPOINT/api/projects/$ERRORGAP_PROJECT_SLUG/notices" \
+  -H "content-type: application/json" \
+  -H "x-errorgap-project-key: $ERRORGAP_API_KEY" \
+  -d '{"errors":[{"type":"ErrorgapInstallTest","message":"Errorgap install verification"}],"context":{"environment":"development"}}'
+```
+
+Then trigger a real error and confirm it appears in the Errorgap UI.
+
+## Development
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+MIT.

errorgap-0.1.0/README.md

@@ -0,0 +1,127 @@
+# errorgap
+
+Python notifier for [Errorgap](https://errorgap.com). Captures exceptions,
+normalizes tracebacks, and ships notices to an Errorgap server. Single
+package covers plain Python, Django, Flask, and FastAPI.
+
+## Install
+
+```sh
+pip install errorgap
+```
+
+For framework integrations:
+
+```sh
+pip install "errorgap[django]"   # or [flask], [fastapi]
+```
+
+Requires Python 3.9+.
+
+## Configure
+
+```python
+import errorgap
+
+errorgap.init(
+    endpoint=...,
+    project_slug=...,
+    api_key=...,
+    environment="production",
+)
+```
+
+`init` reads the same values from `ERRORGAP_ENDPOINT`,
+`ERRORGAP_PROJECT_SLUG`, `ERRORGAP_PROJECT_ID`, and `ERRORGAP_API_KEY` if you
+don't pass them. By default it installs a `sys.excepthook` to catch
+uncaught exceptions in scripts; pass `capture_globals=False` to skip.
+
+## Manual notification
+
+```python
+try:
+    risky()
+except Exception as exc:
+    errorgap.notify(exc, context={"component": "billing"})
+    raise
+```
+
+`notify` returns a `DeliveryResult` (`status`, `body`, `error`, `queued`).
+The SDK never raises.
+
+## Django
+
+Add to `MIDDLEWARE`:
+
+```python
+MIDDLEWARE = [
+    "errorgap.django.ErrorgapMiddleware",
+    # ... your existing middleware ...
+]
+```
+
+## Flask
+
+```python
+from flask import Flask
+from errorgap.flask import init_app
+
+app = Flask(__name__)
+init_app(app)
+```
+
+## FastAPI
+
+```python
+from fastapi import FastAPI
+from errorgap.fastapi import ErrorgapMiddleware
+
+app = FastAPI()
+app.add_middleware(ErrorgapMiddleware)
+```
+
+## Configuration reference
+
+| Argument | Default | Notes |
+|---|---|---|
+| `endpoint` | `ERRORGAP_ENDPOINT` or `http://127.0.0.1:3030` | Base URL, no trailing slash |
+| `project_slug` | `ERRORGAP_PROJECT_SLUG` | **Required** |
+| `project_id` | `ERRORGAP_PROJECT_ID` | Optional, embedded in payload |
+| `api_key` | `ERRORGAP_API_KEY` | Sent as `x-errorgap-project-key` |
+| `environment` | `ERRORGAP_ENVIRONMENT`, `ENV`, or `development` | |
+| `root_directory` | `os.getcwd()` | Used to mark frames as `in_app` |
+| `async_` | `True` | Background-thread delivery |
+| `logger` | `logging.getLogger("errorgap")` | Pass `None` to silence |
+| `filter_keys` | `("password", "token", ...)` | Substring match, case-insensitive |
+| `capture_globals` | `True` | Install `sys.excepthook` |
+
+## Graceful shutdown
+
+```python
+errorgap.flush(timeout=5)     # wait for queued deliveries
+errorgap.shutdown(timeout=5)  # flush + tear down background thread
+```
+
+## Verify
+
+```sh
+curl -sS -X POST "$ERRORGAP_ENDPOINT/api/projects/$ERRORGAP_PROJECT_SLUG/notices" \
+  -H "content-type: application/json" \
+  -H "x-errorgap-project-key: $ERRORGAP_API_KEY" \
+  -d '{"errors":[{"type":"ErrorgapInstallTest","message":"Errorgap install verification"}],"context":{"environment":"development"}}'
+```
+
+Then trigger a real error and confirm it appears in the Errorgap UI.
+
+## Development
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+## License
+
+MIT.

errorgap-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "errorgap"
+version = "0.1.0"
+description = "Python notifier for Errorgap error tracking."
+readme = "README.md"
+license = { text = "MIT" }
+authors = [{ name = "Errorgap" }]
+requires-python = ">=3.9"
+keywords = ["errorgap", "error-tracking", "exceptions", "monitoring"]
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Software Development :: Bug Tracking",
+]
+dependencies = []
+
+[project.optional-dependencies]
+django = ["django>=4.2"]
+flask = ["flask>=2.3"]
+fastapi = ["fastapi>=0.100", "starlette>=0.27"]
+dev = [
+  "pytest>=8",
+  "django>=4.2",
+  "flask>=2.3",
+  "fastapi>=0.100",
+  "httpx>=0.27",
+  "starlette>=0.27",
+]
+
+[project.urls]
+Homepage = "https://github.com/errorgaphq/errorgap-python"
+Source = "https://github.com/errorgaphq/errorgap-python"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/errorgap"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"

errorgap-0.1.0/src/errorgap/__init__.py

@@ -0,0 +1,108 @@
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from .client import Client, DeliveryResult
+from .configuration import Configuration
+from .handlers import install_excepthook, uninstall_excepthook
+from .version import VERSION
+
+__all__ = [
+    "init",
+    "notify",
+    "flush",
+    "shutdown",
+    "configuration",
+    "client",
+    "Configuration",
+    "Client",
+    "DeliveryResult",
+    "VERSION",
+]
+
+_configuration = Configuration()
+_client = Client(_configuration)
+
+
+def init(
+    *,
+    endpoint: Optional[str] = None,
+    project_slug: Optional[str] = None,
+    project_id: Optional[str] = None,
+    api_key: Optional[str] = None,
+    environment: Optional[str] = None,
+    root_directory: Optional[str] = None,
+    async_: Optional[bool] = None,
+    filter_keys: Optional[tuple] = None,
+    logger: Optional[Any] = None,
+    capture_globals: bool = True,
+) -> None:
+    """Configure the SDK and install global error hooks.
+
+    Reads ``ERRORGAP_ENDPOINT``, ``ERRORGAP_PROJECT_SLUG``,
+    ``ERRORGAP_PROJECT_ID``, and ``ERRORGAP_API_KEY`` from the environment when
+    the matching keyword argument is omitted.
+    """
+    global _configuration, _client
+
+    overrides: Dict[str, Any] = {}
+    if endpoint is not None:
+        overrides["endpoint"] = endpoint
+    if project_slug is not None:
+        overrides["project_slug"] = project_slug
+    if project_id is not None:
+        overrides["project_id"] = project_id
+    if api_key is not None:
+        overrides["api_key"] = api_key
+    if environment is not None:
+        overrides["environment"] = environment
+    if root_directory is not None:
+        overrides["root_directory"] = root_directory
+    if async_ is not None:
+        overrides["async_"] = async_
+    if filter_keys is not None:
+        overrides["filter_keys"] = filter_keys
+    if logger is not None:
+        overrides["logger"] = logger
+
+    _configuration = Configuration(**overrides)
+    _client.configure(_configuration)
+
+    if capture_globals:
+        install_excepthook(_client)
+    else:
+        uninstall_excepthook()
+
+
+def notify(
+    exc: BaseException,
+    context: Optional[Dict[str, Any]] = None,
+    environment: Optional[Dict[str, Any]] = None,
+    session: Optional[Dict[str, Any]] = None,
+    params: Optional[Dict[str, Any]] = None,
+    sync: bool = False,
+) -> DeliveryResult:
+    return _client.notify(
+        exc,
+        context=context,
+        environment=environment,
+        session=session,
+        params=params,
+        sync=sync,
+    )
+
+
+def flush(timeout: Optional[float] = None) -> None:
+    _client.flush(timeout)
+
+
+def shutdown(timeout: Optional[float] = None) -> None:
+    _client.shutdown(timeout)
+
+
+def configuration() -> Configuration:
+    return _configuration
+
+
+def client() -> Client:
+    return _client

errorgap-0.1.0/src/errorgap/backtrace.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+import os
+import traceback
+from typing import Any, Dict, List, Optional
+
+
+def parse_backtrace(exc: BaseException, root_directory: str) -> List[Dict[str, Any]]:
+    frames: List[Dict[str, Any]] = []
+    tb_frames = traceback.extract_tb(exc.__traceback__)
+
+    for index, frame in enumerate(tb_frames):
+        file = frame.filename
+        frames.append(
+            {
+                "file": _relative_file(file, root_directory),
+                "line": frame.lineno,
+                "function": frame.name,
+                "in_app": _is_in_app(file, root_directory),
+                "index": index,
+            }
+        )
+
+    return frames
+
+
+def _relative_file(file: Optional[str], root: str) -> Optional[str]:
+    if not file:
+        return file
+    if not root:
+        return file
+    normalized = root if root.endswith(os.sep) else root + os.sep
+    if file.startswith(normalized):
+        return file[len(normalized):]
+    return file
+
+
+def _is_in_app(file: Optional[str], root: str) -> bool:
+    if not file or not root:
+        return False
+    if "site-packages" in file:
+        return False
+    if file.startswith("<"):
+        return False
+    return file.startswith(root)