https://github.com/codex-team/hawk.python
Codex Hawk python catcher
https://github.com/codex-team/hawk.python
Last synced: about 2 months ago
JSON representation
Codex Hawk python catcher
- Host: GitHub
- URL: https://github.com/codex-team/hawk.python
- Owner: codex-team
- License: mit
- Created: 2017-06-17T14:32:59.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-18T18:02:01.000Z (5 months ago)
- Last Synced: 2025-04-14T23:08:23.214Z (about 2 months ago)
- Language: Python
- Size: 114 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hawk Python Catcher
Python errors Catcher module for [Hawk.so](https://hawk.so).
## Usage
Register an account and get a new project token.
If you want to connect specific frameworks see [Flask integration](./docs/flask.md), [FastAPI integration](./docs/fastapi.md).
### Install module
Install `hawk-python-sdk` from PyPI.
```shell
$ pip install hawk-python-sdk
```
Import Catcher module to your project.
```python
from hawk_python_sdk import Hawk
```
Then enable Hawk Catcher with your token and domain.
```python
hawk = Hawk(
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcm9qZWN0SWQiOiI1ZTZmNWM3NzAzOWI0MDAwMjNmZDViODAiLCJpYXQiOjE1ODQzNTY0NzF9.t-5Gelx3MgHVBrxTsoMyPQAdQ6ufVbPsts9zZLW3gM8")
```
Now all global errors would be sent to Hawk.
### Try-except
If you want to catch errors in try-except blocks then use `hawk.catch()` in except:
```python
try:
...
except:
hawk.send()
```
### Manual sending
You can also pass event to the `hawk.send()` call, for example:
```python
try:
...
except:
hawk.send(ValueError("error description"))
```
### Event context
It is possible to pass additional event context for debugging purposes:
```python
try:
...
except:
hawk.send(ValueError("error description"), {"params": "value"})
```
### Affected user
You can also pass user, who affected with specific error:
```python
try:
...
except:
hawk.send(ValueError("error description"), {"params": "value"}, {"id": 123})
```
## Init params
To init Hawk Catcher just pass a project token.
```python
hawk = Hawk('1234567-abcd-8901-efgh-123456789012')
```
### Additional params
If you need to use custom Hawk server then pass a dictionary with params.
```python
hawk = Hawk({
'token': '1234567-abcd-8901-efgh-123456789012',
'collector_endpoint': 'https://.k1.hawk.so',
})
```
Parameters:
| name | type | required | description |
| -------------------- | ---------------------- | ------------ | ------------------------------------------------------------------------ |
| `token` | str | **required** | Your project's Integration Token |
| `release` | str | optional | Release name for Suspected Commits feature |
| `collector_endpoint` | string | optional | Collector endpoint for sending event to |
| `context` | dict | optional | Additional context to be send with every event |
| `before_send` | Callable[[dict], None] | optional | This Method allows you to filter any data you don't want sending to Hawk |
## Requirements
- Python \>= 3.10
- requests
## Links
Repository:
Report a bug:
PyPI Package:
CodeX Team: