Metadata-Version: 2.4
Name: api-entreprise
Version: 31.0.1
Project-URL: Repository, https://github.com/SIB-rennes/api-entreprise
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests~=2.28
Requires-Dist: marshmallow~=3.19
Requires-Dist: marshmallow-dataclass~=8.5
Provides-Extra: ratelimit
Requires-Dist: pyrate-limiter~=2.10; extra == "ratelimit"
Requires-Dist: redis~=4.3; extra == "ratelimit"
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: vcrpy>=4.2; extra == "test"
Dynamic: license-file

# Client API entreprise

Client pour [https://api.gouv.fr/les-api/api-entreprise](https://api.gouv.fr/les-api/api-entreprise).


## Ajout de la dépendance dans un requirements.txt

Par exemple:

```
api-entreprise>=31,<32
```

## Uilisation de la cli

Une CLI est fournie avec la bibliothèque

### Installation

```bash
python -m pipx install api-entreprise
```

### Utilisation

```bash
api-entreprise --help
```

## Utilisation d'un ratelimiter client

Il est possible d'utiliser un ratelimiter client basé sur https://pypi.org/project/pyrate-limiter/ en version 2.10+ pour éviter de faire des appels à l'API entreprise trop rapidement et de se faire bloquer. Notez tout de même que ce client reste compatible avec les headers de ratelimit (429).

Depuis la version 31, le ratelimiter client est optionnel. Il est possible de l'installer avec l'extras `api-entreprise[ratelimiter]`.
