ecoledirecte 0.2.3__py3-none-any.whl

ecoledirecte-0.2.3.dist-info/METADATA

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: ecoledirecte
+Version: 0.2.3
+Summary: Async Python client to interact with Ecole Directe API.
+License: LGPL-3.0-or-later
+License-File: LICENSE
+Author: Giga77
+Maintainer: Giga77
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: Free for non-commercial use
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Natural Language :: French
+Classifier: Topic :: Internet :: WWW/HTTP
+Requires-Dist: aiohttp (>=3.9.5)
+Requires-Dist: backoff (>=1.10.0,<3.0)
+Project-URL: Bug Tracker, https://github.com/hacf-fr/ecoledirecte_api/issues
+Project-URL: Changelog, https://github.com/hacf-fr/ecoledirecte_api/releases
+Project-URL: Homepage, https://github.com/hacf-fr/ecoledirecte_api
+Project-URL: Repository, https://github.com/hacf-fr/ecoledirecte_api
+Description-Content-Type: text/x-rst
+
+=================
+Ecole Directe API
+=================
+|PyPI| |Python Version| |License|
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/ecoledirecte.svg
+   :target: https://pypi.org/project/ecoledirecte/
+   :alt: PyPI
+.. |Python Version| image:: https://img.shields.io/pypi/pyversions/ecoledirecte
+   :target: https://pypi.org/project/ecoledirecte
+   :alt: Python Version
+.. |License| image:: https://img.shields.io/pypi/l/ecoledirecte
+   :target: https://opensource.org/licenses/lgpl-3-0
+   :alt: License
+
+A fully async and easy to use API client for the Ecole Directe API.
+This package is mainly used by Home Assistant, to offer the Ecole Directe integration. If you want to use this package in your own project, you can look at the `Home Assistant Code`_ for more examples.
+
+* Free software: GNU General Public License v3
+* Documentation: https://ecoledirecte-api.readthedocs.io.
+
+Features
+--------
+
+* TODO
+
+Installation
+------------
+
+.. code:: console
+
+   $ pip install ecoledirecte
+
+Getting started
+---------------
+
+.. code:: python
+        
+    import asyncio
+    import json
+    import logging
+    from pathlib import Path
+    from ecoledirecte_api.client import EDClient
+    from ecoledirecte_api.exceptions import BaseEcoleDirecteException
+    
+    logger = logging.getLogger(__name__)
+    
+    async def save_question(qcm_json):
+        """Save question to file."""
+        with Path("qcm.json").open(
+            "w",
+            encoding="utf-8",
+        ) as fp:
+            json.dump(qcm_json, fp, indent=4, ensure_ascii=False)
+        logger.info("Saved question to file", qcm_json)
+    
+    
+    async def main():
+        logging.basicConfig(filename="myapp.log", level=logging.DEBUG)
+        logger.info("Started")
+        try:
+            qcm_json = {}
+            with Path("qcm.json").open(
+                "r",
+                encoding="utf-8",
+            ) as fp:
+                qcm_json = json.load(fp)
+    
+                async with EDClient(
+                    "user", "password", qcm_json
+                ) as client:
+                    client.on_new_question(save_question)
+                    l = await client.login()
+                    logger.info(f"l= {l}")
+                    logger.info(f"Logged in as {client.username}")
+                    logger.info("Finished")
+                    await client.close()
+        except BaseEcoleDirecteException as e:
+            logger.exception(e.message)
+            return
+        except Exception as e:
+            logger.exception(e)
+            return
+    
+    if __name__ == "__main__":
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(main())
+
+Development - DevContainer (recommended)
+----------------------------------------
+
+If you use Visual Studio Code with Docker or GitHub CodeSpaces, you can leverage the available devcontainer. This will install all required dependencies and tools and has the right Python version available. Easy!
+
+
+Credits
+-------
+
+This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
+
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+.. _`Home Assistant Code`: https://github.com/hacf-fr/hass-ecoledirecte
+
+

ecoledirecte-0.2.3.dist-info/RECORD

@@ -0,0 +1,8 @@
+ecoledirecte_api/__init__.py,sha256=KznX0dD3DPMY8Iu5vAc-zmmaZUBC008RSNUYOrjP2Pw,96
+ecoledirecte_api/client.py,sha256=ys7gVq3HBG1rudpe5Su8xtPHi7CCGh76XtRSrdt8kfQ,24643
+ecoledirecte_api/const.py,sha256=X9PUCnCbHdlVnKoHQ1NxwS_WyUTXNz6867aPSzVH-EM,162
+ecoledirecte_api/exceptions.py,sha256=o05879j1A5R8YuFY1wBVK69FZrI6hW9JRhed_nBJolg,1432
+ecoledirecte-0.2.3.dist-info/METADATA,sha256=pQVYvxrjja5ZRe1SB3fiWq_xas3_EkcfaBf7U75hp0Q,4193
+ecoledirecte-0.2.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+ecoledirecte-0.2.3.dist-info/licenses/LICENSE,sha256=32oqs9XKcstQhSPLdLReBIRVZeRVMS3C5dmzzm8DBs8,35254
+ecoledirecte-0.2.3.dist-info/RECORD,,

ecoledirecte-0.2.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.2.1
+Root-Is-Purelib: true
+Tag: py3-none-any