# Flipr Python API REST Client
Client Python pour l'API Flipr. | Python client for Flipr API.
[](https://pypi.org/project/flipr-api/)
[](https://github.com/cnico/flipr-api/releases)
[](https://pypi.org/project/flipr-api/)
[](https://github.com/psf/black)
[](https://flipr-api.readthedocs.io/)
[](https://codecov.io/gh/cnico/flipr-api)
[](https://github.com/cnico/flipr-api/commits/master)
You will find English README content in the section [For English speaking users](#for-english-speaking-users).
Vous trouverez le contenu francophone du README dans la section [Pour les francophones](#pour-les-francophones).
## Pour les francophones
### Description
Flipr est un objet connecté que l'on met dans sa piscine pour mesurer en continu les valeurs chimiques de celle-ci.
Ce package Python permet de gérer la communication avec l'API REST publique [Flipr API](https://apis.goflipr.com/Help).
Le client permet de :
- Récupérer l'id de votre flipr.
- Accéder à la mesure la plus récente de votre Flipr (données de température, ph, chlore et redox).
Pour utiliser le client, il vous faudra disposer de vos identifiants et mot de passe Flipr créés avec l'application mobile.
Ce package a été développé avec l'intention d'être utilisé par [Home-Assistant](https://home-assistant.io/) mais il peut être utilisé dans d'autres contextes.
### Installation
Pour utiliser le module Python **flipr_api** vous devez en premier installer le package en utilisant [pip](https://pip.pypa.io/) depuis [PyPI](https://pypi.org/):
```console
pip install flipr-api
```
Vous pouvez trouver un exemple d'usage en regardant [le test d'intégration](https://github.com/cnico/flipr-api/blob/main/tests/test_integrations.py).
Vous pouvez également faire un test direct de l'API REST en suivant l'exemple [testing_api.md](https://github.com/cnico/flipr-api/blob/main/testing_api.md).
### Contribuer
Les contributions sont les bienvenues. Vous pouvez ouvrir une pull request.
## For English speaking users
### Description english
Flipr is a connect object that you put in your swimming pool in order to measure chemical values of it.
This Python package allows to communicate with the public REST API [Flipr API](https://apis.goflipr.com/Help).
This client allows to :
- Retrieve the id of your flipr
- Get the latest measure of your Flipr (data of temperature, ph, chlorine and redox).
To use this client, it requires you have your login and password created with Flipr's mobile application.
This package has been developed to be used with [Home-Assistant](https://home-assistant.io/) but it can be used in other contexts.
### Installation english
To use the **flipr_api** Python module, you have to install this package first via [pip](https://pip.pypa.io/) from [PyPI](https://pypi.org/):
```console
pip install flipr-api
```
You will find an example ot usage in a Python program in the [le test d'intégration](https://github.com/cnico/flipr-api/blob/main/tests/test_integrations.py).
You can test directly the flipr API following the given sample [testing_api.md](https://github.com/cnico/flipr-api/blob/main/testing_api.md).
### Contributing
Contributions are welcomed. You can open pull requests.
## Credits
This project was inspired from the [MeteoFranceAPI](https://github.com/hacf-fr/meteofrance-api) HACF project.
Raw data
{
"_id": null,
"home_page": "https://github.com/cnico/flipr-api",
"name": "flipr-api",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.10.0",
"maintainer_email": null,
"keywords": "flipr, flipr-api, pool, piscine",
"author": "cnico",
"author_email": null,
"download_url": null,
"platform": null,
"description": "# Flipr Python API REST Client\n\nClient Python pour l'API Flipr. | Python client for Flipr API.\n\n[](https://pypi.org/project/flipr-api/)\n[](https://github.com/cnico/flipr-api/releases)\n[](https://pypi.org/project/flipr-api/)\n[](https://github.com/psf/black)\n[](https://flipr-api.readthedocs.io/)\n[](https://codecov.io/gh/cnico/flipr-api)\n[](https://github.com/cnico/flipr-api/commits/master)\n\nYou will find English README content in the section [For English speaking users](#for-english-speaking-users).\n\nVous trouverez le contenu francophone du README dans la section [Pour les francophones](#pour-les-francophones).\n\n## Pour les francophones\n\n### Description\n\nFlipr est un objet connect\u00e9 que l'on met dans sa piscine pour mesurer en continu les valeurs chimiques de celle-ci.\nCe package Python permet de g\u00e9rer la communication avec l'API REST publique [Flipr API](https://apis.goflipr.com/Help).\n\nLe client permet de :\n\n- R\u00e9cup\u00e9rer l'id de votre flipr.\n- Acc\u00e9der \u00e0 la mesure la plus r\u00e9cente de votre Flipr (donn\u00e9es de temp\u00e9rature, ph, chlore et redox).\n\nPour utiliser le client, il vous faudra disposer de vos identifiants et mot de passe Flipr cr\u00e9\u00e9s avec l'application mobile.\n\nCe package a \u00e9t\u00e9 d\u00e9velopp\u00e9 avec l'intention d'\u00eatre utilis\u00e9 par [Home-Assistant](https://home-assistant.io/) mais il peut \u00eatre utilis\u00e9 dans d'autres contextes.\n\n### Installation\n\nPour utiliser le module Python **flipr_api** vous devez en premier installer le package en utilisant [pip](https://pip.pypa.io/) depuis [PyPI](https://pypi.org/):\n\n```console\n pip install flipr-api\n```\n\nVous pouvez trouver un exemple d'usage en regardant [le test d'int\u00e9gration](https://github.com/cnico/flipr-api/blob/main/tests/test_integrations.py).\n\nVous pouvez \u00e9galement faire un test direct de l'API REST en suivant l'exemple [testing_api.md](https://github.com/cnico/flipr-api/blob/main/testing_api.md).\n\n### Contribuer\n\nLes contributions sont les bienvenues. Vous pouvez ouvrir une pull request.\n\n## For English speaking users\n\n### Description english\n\nFlipr is a connect object that you put in your swimming pool in order to measure chemical values of it.\nThis Python package allows to communicate with the public REST API [Flipr API](https://apis.goflipr.com/Help).\n\nThis client allows to :\n\n- Retrieve the id of your flipr\n- Get the latest measure of your Flipr (data of temperature, ph, chlorine and redox).\n\nTo use this client, it requires you have your login and password created with Flipr's mobile application.\n\nThis package has been developed to be used with [Home-Assistant](https://home-assistant.io/) but it can be used in other contexts.\n\n### Installation english\n\nTo use the **flipr_api** Python module, you have to install this package first via [pip](https://pip.pypa.io/) from [PyPI](https://pypi.org/):\n\n```console\n pip install flipr-api\n```\n\nYou will find an example ot usage in a Python program in the [le test d'int\u00e9gration](https://github.com/cnico/flipr-api/blob/main/tests/test_integrations.py).\n\nYou can test directly the flipr API following the given sample [testing_api.md](https://github.com/cnico/flipr-api/blob/main/testing_api.md).\n\n### Contributing\n\nContributions are welcomed. You can open pull requests.\n\n## Credits\n\nThis project was inspired from the [MeteoFranceAPI](https://github.com/hacf-fr/meteofrance-api) HACF project.\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Python client for flipr API.",
"version": "1.6.1",
"project_urls": {
"Changelog": "https://github.com/cnico/flipr-api/releases",
"Documentation": "https://flipr-api.readthedocs.io",
"Homepage": "https://github.com/cnico/flipr-api",
"Repository": "https://github.com/cnico/flipr-api"
},
"split_keywords": [
"flipr",
" flipr-api",
" pool",
" piscine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c4c377f3b105f07680f701c2309291666d64769b1519406ce897f40c7e6b4168",
"md5": "a91e5239af44c5757bf1ac00bb85e2ef",
"sha256": "32d24d5cc3b0b46576afbdb54fe8c78b8bc03d922cc44628f3cac67375c83f17"
},
"downloads": -1,
"filename": "flipr_api-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a91e5239af44c5757bf1ac00bb85e2ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.10.0",
"size": 19046,
"upload_time": "2024-09-02T20:08:40",
"upload_time_iso_8601": "2024-09-02T20:08:40.253142Z",
"url": "https://files.pythonhosted.org/packages/c4/c3/77f3b105f07680f701c2309291666d64769b1519406ce897f40c7e6b4168/flipr_api-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-02 20:08:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cnico",
"github_project": "flipr-api",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "flipr-api"
}
JSON
