Skip to content

Commit

Permalink
fix: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
slaveeks committed Jan 7, 2025
1 parent 97583ad commit a2aa95b
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ If you want to connect specific frameworks see [Flask integration](./docs/flask.

### Install module

Install `hawkcatcher` from PyPI.
Install `hawk_python_sdk` from PyPI.

```shell
$ pip install hawkcatcher
$ pip install hawk_python_sdk
```

Import Catcher module to your project.

```python
from hawkcatcher import Hawk
from hawk_python_sdk import Hawk
```

Then enable Hawk Catcher with your token and domain.
Expand Down Expand Up @@ -106,7 +106,7 @@ Parameters:

## Requirements

- Python \>= 3.9
- Python \>= 3.12
- requests

## Links
Expand Down
14 changes: 7 additions & 7 deletions docs/fastapi.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Flask integration
# FastAPI integration

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

## Installation

```bash
pip install hawkcatcher[fastapi]
pip install hawk_python_sdk[fastapi]
```

import Catcher module to your project.

```python
from hawkcatcher.modules.fastapi import HawkFastapi
from hawk_python_sdk.modules.fastapi import HawkFastapi
```

```python
app = FastAPI()

hawk = HawkFastapi(
hawk = HawkFastapi({
'app_instance': app,
'token': '1234567-abcd-8901-efgh-123456789012'
)
})
```

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

hawk = HawkFastapi(
hawk = HawkFastapi({
'app_instance': app,
'token': '1234567-abcd-8901-efgh-123456789012'
)
})
```

### Additional params
Expand Down
4 changes: 2 additions & 2 deletions docs/flask.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ This extension adds support for the [Flask](http://flask.pocoo.org/) web framewo
## Installation

```bash
pip install hawkcatcher[flask]
pip install hawk_python_sdk[flask]
```

import Catcher module to your project.

```python
from hawkcatcher.modules.flask import HawkFlask
from hawk_python_sdk.modules.flask import HawkFlask
```

```python
Expand Down

0 comments on commit a2aa95b

Please sign in to comment.