https://github.com/mathis-lambert/api_client
Python Library which can be used in various projects in order to connect to my api webservice.
https://github.com/mathis-lambert/api_client
Last synced: 10 months ago
JSON representation
Python Library which can be used in various projects in order to connect to my api webservice.
- Host: GitHub
- URL: https://github.com/mathis-lambert/api_client
- Owner: mathis-lambert
- License: mit
- Created: 2025-02-23T17:01:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-18T09:36:34.000Z (10 months ago)
- Last Synced: 2025-08-18T11:29:37.463Z (10 months ago)
- Language: Python
- Size: 43 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Client
`ml_api_client` est une bibliothèque Python conçue pour faciliter l'interaction avec l'API de Mathis LAMBERT. Elle
utilise `aiohttp` pour gérer les requêtes HTTP de manière asynchrone, ce qui la rend idéale pour les applications
nécessitant des performances élevées et une gestion efficace des connexions simultanées.
## Fonctionnalités
- **Connexion asynchrone** : Utilise `aiohttp` pour des requêtes HTTP non bloquantes.
- **Facile à utiliser** : API simple et intuitive pour une intégration rapide dans vos projets.
- **Authentification sécurisée** : Supporte l'authentification par jeton et clé API.
- **Gestion des sessions** : Support des cookies et des en-têtes personnalisés.
- **Modèles Pydantic** : Utilisation de modèles Pydantic pour la validation et la gestion des données.
## Installation
Pour installer `ml_api_client`, utilisez pip :
```bash
pip install ml_api_client
```
## Utilisation
Voici un exemple de base pour utiliser `ml_api_client` dans votre projet :
```python
import asyncio
from ml_api_client import APIClient
async def main():
# Initialisez le client avec l'URL de base de votre API
client = APIClient(api_key="your_api_key")
# Effectuez une requête de connexion asynchrone
response = await client.auth.login(username="your_username", password="your_password")
print(response)
# Exécutez la fonction principale
asyncio.run(main())
```
## Configuration
Vous pouvez configurer `APIClient` avec différentes options :
- `base_url` : L'URL de base de votre API.
- `api_key` : Clé API pour l'authentification.
- `headers` : En-têtes HTTP personnalisés.
- `timeout` : Délai d'attente pour les requêtes.
```python
client = APIClient(
base_url="https://api.mathislambert.fr/v1",
api_key="your_api_key",
headers={"Authorization": "Bearer YOUR_TOKEN"},
timeout=10
)
```
## Contribution
Les contributions sont les bienvenues ! Pour contribuer :
1. Forkez le dépôt.
2. Créez une branche pour votre fonctionnalité (`git checkout -b feature/new-feature`).
3. Commitez vos modifications (`git commit -am 'Add new feature'`).
4. Poussez vers la branche (`git push origin feature/new-feature`).
5. Ouvrez une Pull Request.
## Licence
Ce projet est sous licence MIT. Voir le fichier [LICENSE](LICENSE) pour plus de détails.
## Contact
Pour toute question ou suggestion, n'hésitez pas à ouvrir une issue ou à contacter l'auteur :
- **Mathis LAMBERT** : mathislambert.dev@gmail.com