Flipr Python API REST Client
============================
Client Python pour l'API Flipr. | Python client for Flipr API.
|PyPI| |GitHub Release| |Python Version| |License| |Black|
|Read the Docs| |Codecov| |GitHub Activity|
.. |PyPI| image:: https://img.shields.io/pypi/v/flipr-api
:target: https://pypi.org/project/flipr-api/
:alt: PyPI
.. |GitHub Release| image:: https://img.shields.io/github/release/cnico/flipr-api.svg
:target: https://github.com/cnico/flipr-api/releases
:alt: GitHub Release
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/flipr-api
:target: https://pypi.org/project/flipr-api/
:alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/flipr-api
:target: https://opensource.org/licenses/MIT
:alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/flipr-api/latest.svg?label=Read%20the%20Docs
:target: https://flipr-api.readthedocs.io/
:alt: Read the documentation at https://flipr-api.readthedocs.io/
.. |Codecov| image:: https://codecov.io/gh/cnico/flipr-api/branch/main/graph/badge.svg
:target: https://codecov.io/gh/cnico/flipr-api
:alt: Codecov
.. |GitHub Activity| image:: https://img.shields.io/github/commit-activity/y/cnico/flipr-api.svg
:target: https://github.com/cnico/flipr-api/commits/master
:alt: GitHub Activity
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
You will find English README content in the section `For English speaking users`_.
Vous trouverez le contenu francophone du README dans la section `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 <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_ depuis PyPI_:
.. code:: console
$ pip install flipr-api
Vous pouvez trouver un exemple d'usage en regardant
`le test d'intégration <tests/test_integrations.py>`_.
Vous pouvez également faire un test direct de l'API REST en suivant l'exemple `testing_api.rst`_.
Contribuer
^^^^^^^^^^
Les contributions sont les bienvenues. Veuillez consulter les bonnes pratiques
détaillées dans `CONTRIBUTING.rst`_.
For English speaking users
--------------------------
Description En
^^^^^^^^^^^^^^
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 <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
^^^^^^^^^^^^
To use the ``flipr_api`` Python module, you have to install this package first via
pip_ from PyPI_:
.. code:: console
$ pip install flipr-api
You will find an example ot usage in a Python program in the `integration test <tests/test_integrations.py>`_.
You can test directly the flipr API following the given sample `testing_api.rst`_.
Contributing
^^^^^^^^^^^^
Contributions are welcomed. Please check the guidelines in `CONTRIBUTING.rst`_.
Credits
-------
This project was inspired from the MeteoFranceAPI_ HACF project.
.. _MeteoFranceAPI: https://github.com/hacf-fr/meteofrance-api
.. _PyPI: https://pypi.org/
.. _pip: https://pip.pypa.io/
.. _CONTRIBUTING.rst: CONTRIBUTING.rst
.. _testing_api.rst: testing_api.rst
Raw data
{
"_id": null,
"home_page": "https://github.com/cnico/flipr-api",
"name": "flipr-api",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6.1,<4.0.0",
"maintainer_email": "",
"keywords": "flipr,flipr-api,pool,piscine",
"author": "cnico",
"author_email": "",
"download_url": "",
"platform": null,
"description": "Flipr Python API REST Client\n============================\nClient Python pour l'API Flipr. | Python client for Flipr API.\n\n|PyPI| |GitHub Release| |Python Version| |License| |Black|\n\n|Read the Docs| |Codecov| |GitHub Activity|\n\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/flipr-api\n :target: https://pypi.org/project/flipr-api/\n :alt: PyPI\n.. |GitHub Release| image:: https://img.shields.io/github/release/cnico/flipr-api.svg\n :target: https://github.com/cnico/flipr-api/releases\n :alt: GitHub Release\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/flipr-api\n :target: https://pypi.org/project/flipr-api/\n :alt: Python Version\n.. |License| image:: https://img.shields.io/pypi/l/flipr-api\n :target: https://opensource.org/licenses/MIT\n :alt: License\n.. |Read the Docs| image:: https://img.shields.io/readthedocs/flipr-api/latest.svg?label=Read%20the%20Docs\n :target: https://flipr-api.readthedocs.io/\n :alt: Read the documentation at https://flipr-api.readthedocs.io/\n.. |Codecov| image:: https://codecov.io/gh/cnico/flipr-api/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/cnico/flipr-api\n :alt: Codecov\n.. |GitHub Activity| image:: https://img.shields.io/github/commit-activity/y/cnico/flipr-api.svg\n :target: https://github.com/cnico/flipr-api/commits/master\n :alt: GitHub Activity\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n\nYou will find English README content in the section `For English speaking users`_.\n\nVous trouverez le contenu francophone du README dans la section `Pour les francophones`_.\n\nPour les francophones\n---------------------\n\nDescription\n^^^^^^^^^^^\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 <https://apis.goflipr.com/Help>`_.\n\nLe client permet de :\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/>`_\nmais il peut \u00eatre utilis\u00e9 dans d'autres contextes.\n\nInstallation\n^^^^^^^^^^^^\n\nPour utiliser le module Python ``flipr_api`` vous devez en premier installer\nle package en utilisant pip_ depuis PyPI_:\n\n.. code:: console\n\n $ pip install flipr-api\n\n\nVous pouvez trouver un exemple d'usage en regardant\n`le test d'int\u00e9gration <tests/test_integrations.py>`_.\n\nVous pouvez \u00e9galement faire un test direct de l'API REST en suivant l'exemple `testing_api.rst`_.\n\nContribuer\n^^^^^^^^^^\n\nLes contributions sont les bienvenues. Veuillez consulter les bonnes pratiques\nd\u00e9taill\u00e9es dans `CONTRIBUTING.rst`_.\n\n\nFor English speaking users\n--------------------------\n\nDescription En\n^^^^^^^^^^^^^^\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 <https://apis.goflipr.com/Help>`_.\n\nThis client allows to :\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/>`_\nbut it can be used in other contexts.\n\nInstallation\n^^^^^^^^^^^^\n\nTo use the ``flipr_api`` Python module, you have to install this package first via\npip_ from PyPI_:\n\n.. code:: console\n\n $ pip install flipr-api\n\nYou will find an example ot usage in a Python program in the `integration test <tests/test_integrations.py>`_.\n\nYou can test directly the flipr API following the given sample `testing_api.rst`_.\n\nContributing\n^^^^^^^^^^^^\n\nContributions are welcomed. Please check the guidelines in `CONTRIBUTING.rst`_.\n\n\nCredits\n-------\n\nThis project was inspired from the MeteoFranceAPI_ HACF project.\n\n.. _MeteoFranceAPI: https://github.com/hacf-fr/meteofrance-api\n.. _PyPI: https://pypi.org/\n.. _pip: https://pip.pypa.io/\n.. _CONTRIBUTING.rst: CONTRIBUTING.rst\n.. _testing_api.rst: testing_api.rst\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for flipr API.",
"version": "1.5.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": "b90072ebb4b830507d148e8b60d46891741365cd19d7d1f52db8166ba1911251",
"md5": "77579bd9a3c8c0ff9bab6c6fcd277f79",
"sha256": "1df54efbe067e25a76876993fc57f897e5a9aef8893d8e5c342439326de7e495"
},
"downloads": -1,
"filename": "flipr_api-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "77579bd9a3c8c0ff9bab6c6fcd277f79",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6.1,<4.0.0",
"size": 7926,
"upload_time": "2024-01-15T22:17:16",
"upload_time_iso_8601": "2024-01-15T22:17:16.966325Z",
"url": "https://files.pythonhosted.org/packages/b9/00/72ebb4b830507d148e8b60d46891741365cd19d7d1f52db8166ba1911251/flipr_api-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 22:17:16",
"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
