Skip to content

Commit

Permalink
DEV-19025: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexreznikoff committed Feb 7, 2025
1 parent 447caa7 commit 8982907
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ function. It accepts two parameters:
* `method` - method name passed to observe_metrics decorator
* `le` - bucket name (built-in label of Histogram collector)

Usage example
### Usage example

```python
from huntflow_base_metrics import (
Expand Down Expand Up @@ -330,5 +330,20 @@ async def calculate_stats(filters) -> StatsDTO:

```


# TODO: another use-cases and development notes
# Contributing
* First install the [PDM](https://pdm-project.org/en/latest/#recommended-installation-method). The current version used is 2.20.1
* Install `dev` dependencies
```shell
pdm install -dG dev
```
* Make your changes to the code
* Run tests
```shell
pdm run pytest
```
* Run linters
```shell
pdm run ruff check
pdm run ruff format --check
pdm run mypy src
```

0 comments on commit 8982907

Please sign in to comment.