ml-api-client

Name	ml-api-client JSON
Version	0.3.1 JSON
	download
home_page	None
Summary	A Python client for interacting with Mathis LAMBERT's API
upload_time	2025-08-19 20:41:33
maintainer	None
docs_url	None
author	None
requires_python	>=3.13
license	MIT License Copyright (c) 2025 Mathis Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	api client llm chat embeddings vector openai-compatible
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ml-api-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.13",
    "maintainer_email": null,
    "keywords": "api, client, llm, chat, embeddings, vector, openai-compatible",
    "author": null,
    "author_email": "Mathis LAMBERT <mathislambert.dev@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/71/0e/dacc481bc3c0366051546758c608230dd4b16776104497c007870270c9fc/ml_api_client-0.3.1.tar.gz",
    "platform": null,
    "description": "# API Client\r\n\r\n`ml_api_client` est une biblioth\u00e8que Python con\u00e7ue pour faciliter l'interaction avec l'API de Mathis LAMBERT. Elle\r\nutilise `aiohttp` pour g\u00e9rer les requ\u00eates HTTP de mani\u00e8re asynchrone, ce qui la rend id\u00e9ale pour les applications\r\nn\u00e9cessitant des performances \u00e9lev\u00e9es et une gestion efficace des connexions simultan\u00e9es.\r\n\r\n## Fonctionnalit\u00e9s\r\n\r\n- **Connexion asynchrone** : Utilise `aiohttp` pour des requ\u00eates HTTP non bloquantes.\r\n- **Facile \u00e0 utiliser** : API simple et intuitive pour une int\u00e9gration rapide dans vos projets.\r\n- **Authentification s\u00e9curis\u00e9e** : Supporte l'authentification par jeton et cl\u00e9 API.\r\n- **Gestion des sessions** : Support des cookies et des en-t\u00eates personnalis\u00e9s.\r\n- **Mod\u00e8les Pydantic** : Utilisation de mod\u00e8les Pydantic pour la validation et la gestion des donn\u00e9es.\r\n\r\n## Installation\r\n\r\nPour installer `ml_api_client`, utilisez pip :\r\n\r\n```bash\r\npip install ml_api_client\r\n```\r\n\r\n## Utilisation\r\n\r\nVoici un exemple de base pour utiliser `ml_api_client` dans votre projet :\r\n\r\n```python\r\nimport asyncio\r\nfrom ml_api_client import APIClient\r\n\r\n\r\nasync def main():\r\n    # Initialisez le client avec l'URL de base de votre API\r\n    client = APIClient(api_key=\"your_api_key\")\r\n\r\n    # Effectuez une requ\u00eate de connexion asynchrone\r\n    response = await client.auth.login(username=\"your_username\", password=\"your_password\")\r\n    print(response)\r\n\r\n\r\n# Ex\u00e9cutez la fonction principale\r\nasyncio.run(main())\r\n```\r\n\r\n## Configuration\r\n\r\nVous pouvez configurer `APIClient` avec diff\u00e9rentes options :\r\n\r\n- `base_url` : L'URL de base de votre API.\r\n- `api_key` : Cl\u00e9 API pour l'authentification.\r\n- `headers` : En-t\u00eates HTTP personnalis\u00e9s.\r\n- `timeout` : D\u00e9lai d'attente pour les requ\u00eates.\r\n\r\n```python\r\nclient = APIClient(\r\n    base_url=\"https://api.mathislambert.fr/v1\",\r\n    api_key=\"your_api_key\",\r\n    headers={\"Authorization\": \"Bearer YOUR_TOKEN\"},\r\n    timeout=10\r\n)\r\n```\r\n\r\n## Contribution\r\n\r\nLes contributions sont les bienvenues ! Pour contribuer :\r\n\r\n1. Forkez le d\u00e9p\u00f4t.\r\n2. Cr\u00e9ez une branche pour votre fonctionnalit\u00e9 (`git checkout -b feature/new-feature`).\r\n3. Commitez vos modifications (`git commit -am 'Add new feature'`).\r\n4. Poussez vers la branche (`git push origin feature/new-feature`).\r\n5. Ouvrez une Pull Request.\r\n\r\n## Licence\r\n\r\nCe projet est sous licence MIT. Voir le fichier [LICENSE](LICENSE) pour plus de d\u00e9tails.\r\n\r\n## Contact\r\n\r\nPour toute question ou suggestion, n'h\u00e9sitez pas \u00e0 ouvrir une issue ou \u00e0 contacter l'auteur :\r\n\r\n- **Mathis LAMBERT** : mathislambert.dev@gmail.com\r\n",
    "bugtrack_url": null,
    "license": "MIT License\r\n        \r\n        Copyright (c) 2025 Mathis\r\n        \r\n        Permission is hereby granted, free of charge, to any person obtaining a copy\r\n        of this software and associated documentation files (the \"Software\"), to deal\r\n        in the Software without restriction, including without limitation the rights\r\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n        copies of the Software, and to permit persons to whom the Software is\r\n        furnished to do so, subject to the following conditions:\r\n        \r\n        The above copyright notice and this permission notice shall be included in all\r\n        copies or substantial portions of the Software.\r\n        \r\n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n        SOFTWARE.\r\n        ",
    "summary": "A Python client for interacting with Mathis LAMBERT's API",
    "version": "0.3.1",
    "project_urls": {
        "Homepage": "https://github.com/mathis-lambert/ml_api_client",
        "Issues": "https://github.com/mathis-lambert/ml_api_client/issues",
        "Repository": "https://github.com/mathis-lambert/ml_api_client"
    },
    "split_keywords": [
        "api",
        " client",
        " llm",
        " chat",
        " embeddings",
        " vector",
        " openai-compatible"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e093c456eec637f29d34ddacb41af029cb725c64f4432287d82bf64389b59f90",
                "md5": "b348ff5caf1a4f7874778dcb190833ef",
                "sha256": "7def13a3f552355d57735ef17f982cd5a4627ccfa4e4ce0672ac57209469ab4c"
            },
            "downloads": -1,
            "filename": "ml_api_client-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b348ff5caf1a4f7874778dcb190833ef",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.13",
            "size": 16944,
            "upload_time": "2025-08-19T20:41:32",
            "upload_time_iso_8601": "2025-08-19T20:41:32.886129Z",
            "url": "https://files.pythonhosted.org/packages/e0/93/c456eec637f29d34ddacb41af029cb725c64f4432287d82bf64389b59f90/ml_api_client-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "710edacc481bc3c0366051546758c608230dd4b16776104497c007870270c9fc",
                "md5": "65f99523a6a329450537f89b6a7e6b48",
                "sha256": "e2d51338f905488286e6e060f66873626cb3986a965874e09bc3cfc6b083347c"
            },
            "downloads": -1,
            "filename": "ml_api_client-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "65f99523a6a329450537f89b6a7e6b48",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.13",
            "size": 17468,
            "upload_time": "2025-08-19T20:41:33",
            "upload_time_iso_8601": "2025-08-19T20:41:33.840553Z",
            "url": "https://files.pythonhosted.org/packages/71/0e/dacc481bc3c0366051546758c608230dd4b16776104497c007870270c9fc/ml_api_client-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-19 20:41:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mathis-lambert",
    "github_project": "ml_api_client",
    "github_not_found": true,
    "lcname": "ml-api-client"
}