Skip to content

Commit ba5f581

Browse files
authored
Merge pull request #30 from codex-team/fix/docs
2 parents 97583ad + a2aa95b commit ba5f581

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ If you want to connect specific frameworks see [Flask integration](./docs/flask.
1010

1111
### Install module
1212

13-
Install `hawkcatcher` from PyPI.
13+
Install `hawk_python_sdk` from PyPI.
1414

1515
```shell
16-
$ pip install hawkcatcher
16+
$ pip install hawk_python_sdk
1717
```
1818

1919
Import Catcher module to your project.
2020

2121
```python
22-
from hawkcatcher import Hawk
22+
from hawk_python_sdk import Hawk
2323
```
2424

2525
Then enable Hawk Catcher with your token and domain.
@@ -106,7 +106,7 @@ Parameters:
106106

107107
## Requirements
108108

109-
- Python \>= 3.9
109+
- Python \>= 3.12
110110
- requests
111111

112112
## Links

docs/fastapi.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
# Flask integration
1+
# FastAPI integration
22

33
This extension adds support for the [FastAPI](https://fastapi.tiangolo.com/) web framework.
44

55
## Installation
66

77
```bash
8-
pip install hawkcatcher[fastapi]
8+
pip install hawk_python_sdk[fastapi]
99
```
1010

1111
import Catcher module to your project.
1212

1313
```python
14-
from hawkcatcher.modules.fastapi import HawkFastapi
14+
from hawk_python_sdk.modules.fastapi import HawkFastapi
1515
```
1616

1717
```python
1818
app = FastAPI()
1919

20-
hawk = HawkFastapi(
20+
hawk = HawkFastapi({
2121
'app_instance': app,
2222
'token': '1234567-abcd-8901-efgh-123456789012'
23-
)
23+
})
2424
```
2525

2626
Now all global fastapi errors would be sent to Hawk.
@@ -60,10 +60,10 @@ To init Hawk Catcher just pass a project token and FastAPI app instance.
6060
```python
6161
app = FastAPI()
6262

63-
hawk = HawkFastapi(
63+
hawk = HawkFastapi({
6464
'app_instance': app,
6565
'token': '1234567-abcd-8901-efgh-123456789012'
66-
)
66+
})
6767
```
6868

6969
### Additional params

docs/flask.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ This extension adds support for the [Flask](http://flask.pocoo.org/) web framewo
55
## Installation
66

77
```bash
8-
pip install hawkcatcher[flask]
8+
pip install hawk_python_sdk[flask]
99
```
1010

1111
import Catcher module to your project.
1212

1313
```python
14-
from hawkcatcher.modules.flask import HawkFlask
14+
from hawk_python_sdk.modules.flask import HawkFlask
1515
```
1616

1717
```python

0 commit comments

Comments
 (0)