1- Hawk Python Catcher
2- ===========
1+ # Hawk Python Catcher
32
43Python errors Catcher module for [ Hawk.so] ( https://hawk.so ) .
54
6- Usage
7- -----
5+ ## Usage
86
97Register an account and get a new project token.
108
@@ -53,7 +51,6 @@ except:
5351 hawk.send(ValueError (" error description" ))
5452```
5553
56-
5754### Event context
5855
5956It is possible to pass additional event context for debugging purposes:
@@ -76,8 +73,7 @@ except:
7673 hawk.send(ValueError (" error description" ), {" params" : " value" }, {" id" : 123 })
7774```
7875
79- Init params
80- -----------
76+ ## Init params
8177
8278To init Hawk Catcher just pass a project token.
8379
@@ -96,19 +92,27 @@ hawk = Hawk({
9692})
9793```
9894
99- Requirements
100- ------------
95+ Parameters:
96+
97+ | name | type | required | description |
98+ | -------------------- | ---------------------- | ------------ | ------------------------------------------------------------------------ |
99+ | ` token ` | str | ** required** | Your project's Integration Token |
100+ | ` release ` | str | optional | Release name for Suspected Commits feature |
101+ | ` collector_endpoint ` | string | optional | Collector endpoint for sending event to |
102+ | ` context ` | dict | optional | Additional context to be send with every event |
103+ | ` before_send ` | Callable[[ dict] , None] | optional | This Method allows you to filter any data you don't want sending to Hawk |
104+
105+ ## Requirements
101106
102107- Python \> = 3.5
103108- requests
104109
105- Links
106- -----
110+ ## Links
107111
108112Repository: < https://github.com/codex-team/hawk.python >
109113
110114Report a bug: < https://github.com/codex-team/hawk.python/issues >
111115
112116PyPI Package: < https://pypi.python.org/pypi/hawkcatcher >
113117
114- CodeX Team: < https://ifmo.su >
118+ CodeX Team: < https://codex.so/ >
0 commit comments