Official client for Blagues API
Project description
BlaguesAPI Python
Ce paquet Python fournit une interface simple pour intéragir avec Blagues API.
Important : Ce paquet ne fournit que des méthodes asynchrones.
Installation
Vous pouvez simplement ajouter la dépendance à votre projet depuis PyPI :
pip install blagues-api
Utilisation
Pour utiliser l'API, vous devez obtenir une clé gratuite sur le site officiel : https://www.blagues-api.fr/. Vous pourrez ensuite construire un objet BlaguesAPI
:
from blagues_api import BlaguesAPI
blagues = BlaguesAPI("VOTRE_TOKEN_ICI")
Toutes les méthodes excepté count renverront un objet Blague
, qui permet d'accéder aux différentes propriétés renvoyées par l'API : id
, type
, joke
, answer
. En cas d'erreur, vous recevrez une erreur du type aiohttp.ClientResponseError
.
Les différents types de blagues peuvent être représentés au choix sous forme d'un string ou d'un objet BlagueType
(exemple: BlagueType.GENERAL
). La liste des types disponibles est notée dans sur le site officiel.
Blague aléatoire
await blagues.random()
# Blague(id=108, type=<BlagueType.GLOBAL: 'global'>, joke="C'est l'histoire d'un poil. Avant, il était bien.", answer='Maintenant, il est pubien.')
Il est possible de spécifier des catégories à exclure :
await blagues.random(disallow=[BlagueType.LIMIT, BlagueType.BEAUF])
# Avec des strings
await blagues.random(disallow=["limit", "beauf"])
Blague aléatoire catégorisée
await blagues.random_categorized(BlagueType.DEV)
# Blague(id=430, type=<BlagueType.DEV: 'dev'>, joke='De quelle couleur sont tes yeux ?', answer='#1292f4 et toi ?')
# Avec des strings
await blagues.random_categorized("dev")
Blague par identifiant
await blagues.from_id(20)
# Blague(id=20, type=<BlagueType.GLOBAL: 'global'>, joke="Qu'est-ce qu'un chou au milieu de l'océan ?", answer='Un chou marin.')
Nombre de blagues
await blagues.count()
# CountJoke(count=1730)
La méthode ci-dessus renverra un objet CountJoke
, qui permet d'accéder a la propriété renvoyée par l'API : count
. En cas d'erreur, vous recevrez une erreur du type aiohttp.ClientResponseError
.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for blagues_api-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a169aa5f984a7014c7a7181134d566838daad5eac1e8323b24f9c6bd64b45255 |
|
MD5 | b6852d32977c0d89c5c9744b2cc6f9dc |
|
BLAKE2b-256 | f17b458c997b885739c7934164074b84d4d01c7f13b95f54239e9a25176862c6 |