ghosttrap-sdk 0.4.2__tar.gz → 0.4.3__tar.gz

{ghosttrap_sdk-0.4.2 → ghosttrap_sdk-0.4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghosttrap-sdk
-Version: 0.4.2
+Version: 0.4.3
 Summary: Drop-in error reporter for ghosttrap.io
 Project-URL: Homepage, https://github.com/alex-rowley/ghosttrap-sdk
 Requires-Python: >=3.10
@@ -25,12 +25,26 @@ ghosttrap.init("t_your_token_here")
 
 Get your token by running `ghosttrap setup` from [ghosttrap-cli](https://github.com/alex-rowley/ghosttrap-cli).
 
+### Optional kwargs
+
+```python
+ghosttrap.init(
+    "t_your_token_here",
+    server="https://ghosttrap.io",  # override only if self-hosting
+    send_user=False,                # see "User context" below
+)
+```
+
 ## What it hooks into
 
 - **`sys.excepthook`** — unhandled exceptions
 - **Python logging** — `logger.exception()` and `logger.error(..., exc_info=True)`
 - **Celery** — task failures via `celery.signals.task_failure` (auto-detected)
 
+## What it sends
+
+Every report includes the exception type, message, traceback, frames (file/line/function/code), and the server's hostname (`socket.gethostname()`).
+
 ## Django
 
 ```python
@@ -45,6 +59,14 @@ MIDDLEWARE = [
 ]
 ```
 
+## User context
+
+Off by default. Pass `send_user=True` to `init()` and the Django middleware will attach the authenticated user's `id` and `username` to each report. Has no effect outside Django.
+
+```python
+ghosttrap.init("t_your_token_here", send_user=True)
+```
+
 ## Zero dependencies
 
 Pure Python stdlib. No transitive dependencies in your production image.

{ghosttrap_sdk-0.4.2 → ghosttrap_sdk-0.4.3}/README.md

@@ -17,12 +17,26 @@ ghosttrap.init("t_your_token_here")
 
 Get your token by running `ghosttrap setup` from [ghosttrap-cli](https://github.com/alex-rowley/ghosttrap-cli).
 
+### Optional kwargs
+
+```python
+ghosttrap.init(
+    "t_your_token_here",
+    server="https://ghosttrap.io",  # override only if self-hosting
+    send_user=False,                # see "User context" below
+)
+```
+
 ## What it hooks into
 
 - **`sys.excepthook`** — unhandled exceptions
 - **Python logging** — `logger.exception()` and `logger.error(..., exc_info=True)`
 - **Celery** — task failures via `celery.signals.task_failure` (auto-detected)
 
+## What it sends
+
+Every report includes the exception type, message, traceback, frames (file/line/function/code), and the server's hostname (`socket.gethostname()`).
+
 ## Django
 
 ```python
@@ -37,6 +51,14 @@ MIDDLEWARE = [
 ]
 ```
 
+## User context
+
+Off by default. Pass `send_user=True` to `init()` and the Django middleware will attach the authenticated user's `id` and `username` to each report. Has no effect outside Django.
+
+```python
+ghosttrap.init("t_your_token_here", send_user=True)
+```
+
 ## Zero dependencies
 
 Pure Python stdlib. No transitive dependencies in your production image.

{ghosttrap_sdk-0.4.2 → ghosttrap_sdk-0.4.3}/ghosttrap_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ghosttrap-sdk
-Version: 0.4.2
+Version: 0.4.3
 Summary: Drop-in error reporter for ghosttrap.io
 Project-URL: Homepage, https://github.com/alex-rowley/ghosttrap-sdk
 Requires-Python: >=3.10
@@ -25,12 +25,26 @@ ghosttrap.init("t_your_token_here")
 
 Get your token by running `ghosttrap setup` from [ghosttrap-cli](https://github.com/alex-rowley/ghosttrap-cli).
 
+### Optional kwargs
+
+```python
+ghosttrap.init(
+    "t_your_token_here",
+    server="https://ghosttrap.io",  # override only if self-hosting
+    send_user=False,                # see "User context" below
+)
+```
+
 ## What it hooks into
 
 - **`sys.excepthook`** — unhandled exceptions
 - **Python logging** — `logger.exception()` and `logger.error(..., exc_info=True)`
 - **Celery** — task failures via `celery.signals.task_failure` (auto-detected)
 
+## What it sends
+
+Every report includes the exception type, message, traceback, frames (file/line/function/code), and the server's hostname (`socket.gethostname()`).
+
 ## Django
 
 ```python
@@ -45,6 +59,14 @@ MIDDLEWARE = [
 ]
 ```
 
+## User context
+
+Off by default. Pass `send_user=True` to `init()` and the Django middleware will attach the authenticated user's `id` and `username` to each report. Has no effect outside Django.
+
+```python
+ghosttrap.init("t_your_token_here", send_user=True)
+```
+
 ## Zero dependencies
 
 Pure Python stdlib. No transitive dependencies in your production image.

{ghosttrap_sdk-0.4.2 → ghosttrap_sdk-0.4.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ghosttrap-sdk"
-version = "0.4.2"
+version = "0.4.3"
 description = "Drop-in error reporter for ghosttrap.io"
 readme = "README.md"
 requires-python = ">=3.10"