https://github.com/grv96/ghae
This library detects the responses to erroneous requests to the GitHub API. An exception signals these errors.
https://github.com/grv96/ghae
api exception exception-handling github-api githubapi pypi pypi-package pypi-packages python python-exception-handling python-exceptions python-excpetion
Last synced: about 2 months ago
JSON representation
This library detects the responses to erroneous requests to the GitHub API. An exception signals these errors.
- Host: GitHub
- URL: https://github.com/grv96/ghae
- Owner: GRV96
- License: mit
- Created: 2025-03-03T19:06:28.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T19:12:31.000Z (10 months ago)
- Last Synced: 2025-09-28T02:23:49.770Z (3 months ago)
- Topics: api, exception, exception-handling, github-api, githubapi, pypi, pypi-package, pypi-packages, python, python-exception-handling, python-exceptions, python-excpetion
- Language: Python
- Homepage: https://pypi.org/project/ghae/
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ghae
## FRANÇAIS
Cette bibliothèque détecte les réponses aux requêtes erronées à l'API de
GitHub. Une exception signale ces erreurs.
### Contenu
L'exception `GitHubApiError` peut être levée quand une réponse de l'API de
GitHub indique que la requête est erronée. Ses propriétés sont les suivantes.
* `message`: le message d'erreur.
* `doc_url`: l'URL de la documentation de l'erreur.
* `status`: le code du statut de la réponse.
* `req_url`: l'URL de la requête erronée.
La fonction `detect_github_api_error` examine les données provenant de l'API de
GitHub et lève `GitHubApiError` si elles résultent d'une requête erronée. Les
données doivent être un objet produit par la lecture du contenu de la réponse,
qui est en JSON.
L'utilisateur devrait se fier à `detect_github_api_error` plutôt que lever
`GitHubApiError` lui-même.
Pour plus d'informations, consultez la documentation et la démo dans le dépôt
de code source.
### Dépendances
Cette commande installe les dépendances nécessaires au développement de `ghae`.
```
pip install -r requirements-dev.txt
```
### Démo
La démo montre comment déterminer qu'une requête à l'API de GitHub est erronée.
Elle constitue aussi un exemple de gestion de `GitHubApiError`.
Affichez l'aide pour plus d'informations.
```
python demo.py -h
```
Cet exemple envoie une requête valide.
```
python demo.py -r GRV96/ghae
```
Cet exemple envoie une requête erronée.
```
python demo.py -r GRV96/gha
```
### Tests automatiques
Cette commande exécute les tests automatiques.
```
pytest tests
```
## ENGLISH
This library detects the responses to erroneous requests to the GitHub API. An
exception signals these errors.
### Content
Exception `GitHubApiError` can be raised when a response from the GitHub API
indicates that the request is erroneous. Its properties are the following.
* `message`: the error message.
* `doc_url`: the URL to the error's documentation.
* `status`: the response's status code.
* `req_url`: the erroneous request's URL.
Function `detect_github_api_error` examines data from the GitHub API and raises
a `GitHubApiError` if it is the result of an erroneous request. The data must
be an object returned by the parsing of the response's content, which is in
JSON.
The user should rely on `detect_github_api_error` rather than raising
`GitHubApiError` themself.
For more information, consult the documentation and the demo in the source code
repository.
### Dependencies
This command installs the dependencies required for the development of `ghae`.
```
pip install -r requirements-dev.txt
```
### Demo
The demo shows how to find out whether a request to the GitHub API is
erroneous. It also constitutes an example of handling a `GitHubApiError`.
Display the help message for more information.
```
python demo.py -h
```
This example sends a valid request.
```
python demo.py -r GRV96/ghae
```
This example sends an erroneous request.
```
python demo.py -r GRV96/gha
```
### Automated Tests
This command executes the automated tests.
```
pytest tests
```