renault-api 0.5.1__tar.gz

renault_api-0.5.1/LICENSE.rst

@@ -0,0 +1,22 @@
+MIT License
+===========
+
+Copyright © 2020 epenet
+
+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.**

renault_api-0.5.1/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: renault-api
+Version: 0.5.1
+Summary: Renault API
+License: MIT
+License-File: LICENSE.rst
+Author: epenet
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: cli
+Requires-Dist: PyJWT (>=2.8.0)
+Requires-Dist: aiohttp (>=3.9.5)
+Requires-Dist: cffi (>=1.17.0)
+Requires-Dist: click (>=8.0.1) ; extra == "cli"
+Requires-Dist: cryptography (>=44.0.0)
+Requires-Dist: dateparser (>=1.0.0) ; extra == "cli"
+Requires-Dist: marshmallow-dataclass (>=8.2.0)
+Requires-Dist: tabulate (>=0.8.7) ; extra == "cli"
+Project-URL: Changelog, https://github.com/hacf-fr/renault-api/releases
+Project-URL: Documentation, https://renault-api.readthedocs.io
+Project-URL: Homepage, https://github.com/hacf-fr/renault-api
+Project-URL: Repository, https://github.com/hacf-fr/renault-api
+Description-Content-Type: text/x-rst
+
+Renault API
+===========
+
+|PyPI| |Python Version| |License|
+
+|Read the Docs| |Tests| |Codecov|
+
+|pre-commit| |Ruff|
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/renault-api.svg
+   :target: https://pypi.org/project/renault-api/
+   :alt: PyPI
+.. |Python Version| image:: https://img.shields.io/pypi/pyversions/renault-api
+   :target: https://pypi.org/project/renault-api
+   :alt: Python Version
+.. |License| image:: https://img.shields.io/pypi/l/renault-api
+   :target: https://opensource.org/licenses/MIT
+   :alt: License
+.. |Read the Docs| image:: https://img.shields.io/readthedocs/renault-api/latest.svg?label=Read%20the%20Docs
+   :target: https://renault-api.readthedocs.io/
+   :alt: Read the documentation at https://renault-api.readthedocs.io/
+.. |Tests| image:: https://github.com/hacf-fr/renault-api/workflows/Tests/badge.svg
+   :target: https://github.com/hacf-fr/renault-api/actions?workflow=Tests
+   :alt: Tests
+.. |Codecov| image:: https://codecov.io/gh/hacf-fr/renault-api/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/hacf-fr/renault-api
+   :alt: Codecov
+.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
+   :target: https://github.com/pre-commit/pre-commit
+   :alt: pre-commit
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+
+Features
+--------
+
+This Python package manages the communication with the private Renault API used by the official MyRenault application.
+
+The client is able to read various vehicle attributes, such as:
+
+* mileage
+* GPS location
+* fuel autonomy (for fuel vehicles)
+* battery autonomy (for electric vehicles)
+* contracts associated to the vehicle (warranty and connected services)
+
+For some vehicles, it is also possible to manage:
+
+* hvac/pre-conditionning of the vehicle
+* charge schedule
+
+This package has been developed to be used with Home-Assistant, but it can be used in other contexts
+
+
+Requirements
+------------
+
+* Python (>= 3.10)
+
+API Usage
+---------
+
+You can install *Renault API* via pip_ from PyPI_:
+
+.. code:: console
+
+   $ pip install renault-api
+
+.. code:: python
+
+   import aiohttp
+   import asyncio
+
+   from renault_api.renault_client import RenaultClient
+
+   async def main():
+      async with aiohttp.ClientSession() as websession:
+         client = RenaultClient(websession=websession, locale="fr_FR")
+         await client.session.login('email', 'password')
+         print(f"Accounts: {await client.get_person()}") # List available accounts, make a note of kamereon account id
+
+         account_id = "Your Kamereon account id"
+         account = await client.get_api_account(account_id)
+         print(f"Vehicles: {await account.get_vehicles()}") # List available vehicles, make a note of vehicle VIN
+
+         vin = "Your vehicle VIN"
+         vehicle = await account.get_api_vehicle(vin)
+         print(f"Cockpit information: {await vehicle.get_cockpit()}")
+         print(f"Battery status information: {await vehicle.get_battery_status()}")
+
+   loop = asyncio.get_event_loop()
+   loop.run_until_complete(main())
+
+CLI Usage
+---------
+
+The renault-api is also available through a CLI, which requires additional dependencies.
+For the added dependencies, you can install *Renault API* via pip_ from PyPI_:
+
+.. code:: console
+
+   $ pip install renault-api[cli]
+
+Once installed, the following command prompts for credentials and settings, displays basic vehicle status information, and generates traces:
+
+.. code:: console
+
+   $ renault-api --log status
+
+* Credentials will automatically be stored in the user home directory (~/.credentials/renault-api.json)
+* Logs will automatically be generated in `logs` subfolder
+
+It is also possible to use raw http GET/POST commands, for example to get odometer and others data on a Windows machine:
+
+.. code:: console
+
+  C:> renault-api http get /commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/cockpit
+
+Or to request a battery status refresh on a Windows Machine (internal quotes escaped, whole payload enclosed in un-escaped quotes):
+
+.. code:: console
+
+  C:> renault-api http post /commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/actions/refresh-battery-status "{\\"data\\": {\\"type\\": \\"RefreshBatteryStatus\\"}}"
+
+Please see the `Command-line Reference <Usage_>`_ for full details.
+
+Contributing
+------------
+
+Contributions are very welcome.
+To learn more, see the `Contributor Guide`_.
+
+
+License
+-------
+
+Distributed under the terms of the MIT_ license,
+*Renault API* is free and open source software.
+
+
+Disclaimer
+----------
+
+This project is not affiliated with, endorsed by, or connected to Renault. I accept no responsibility for any consequences, intended or accidental, as a as a result of interacting with Renault's API using this project.
+
+
+Issues
+------
+
+If you encounter any problems,
+please `file an issue`_ along with a detailed description.
+
+
+Credits
+-------
+
+This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.
+This project was heavily based on `@jamesremuscat`_'s `PyZE`_ python client for the Renault ZE API.
+
+
+.. _@cjolowicz: https://github.com/cjolowicz
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _@jamesremuscat: https://github.com/jamesremuscat
+.. _PyZE: https://github.com/jamesremuscat/pyze
+.. _MIT: http://opensource.org/licenses/MIT
+.. _PyPI: https://pypi.org/
+.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
+.. _file an issue: https://github.com/hacf-fr/renault-api/issues
+.. _pip: https://pip.pypa.io/
+.. github-only
+.. _Contributor Guide: CONTRIBUTING.rst
+.. _Usage: https://renault-api.readthedocs.io/en/latest/usage.html
+

renault_api-0.5.1/README.rst

@@ -0,0 +1,174 @@
+Renault API
+===========
+
+|PyPI| |Python Version| |License|
+
+|Read the Docs| |Tests| |Codecov|
+
+|pre-commit| |Ruff|
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/renault-api.svg
+   :target: https://pypi.org/project/renault-api/
+   :alt: PyPI
+.. |Python Version| image:: https://img.shields.io/pypi/pyversions/renault-api
+   :target: https://pypi.org/project/renault-api
+   :alt: Python Version
+.. |License| image:: https://img.shields.io/pypi/l/renault-api
+   :target: https://opensource.org/licenses/MIT
+   :alt: License
+.. |Read the Docs| image:: https://img.shields.io/readthedocs/renault-api/latest.svg?label=Read%20the%20Docs
+   :target: https://renault-api.readthedocs.io/
+   :alt: Read the documentation at https://renault-api.readthedocs.io/
+.. |Tests| image:: https://github.com/hacf-fr/renault-api/workflows/Tests/badge.svg
+   :target: https://github.com/hacf-fr/renault-api/actions?workflow=Tests
+   :alt: Tests
+.. |Codecov| image:: https://codecov.io/gh/hacf-fr/renault-api/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/hacf-fr/renault-api
+   :alt: Codecov
+.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
+   :target: https://github.com/pre-commit/pre-commit
+   :alt: pre-commit
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+
+Features
+--------
+
+This Python package manages the communication with the private Renault API used by the official MyRenault application.
+
+The client is able to read various vehicle attributes, such as:
+
+* mileage
+* GPS location
+* fuel autonomy (for fuel vehicles)
+* battery autonomy (for electric vehicles)
+* contracts associated to the vehicle (warranty and connected services)
+
+For some vehicles, it is also possible to manage:
+
+* hvac/pre-conditionning of the vehicle
+* charge schedule
+
+This package has been developed to be used with Home-Assistant, but it can be used in other contexts
+
+
+Requirements
+------------
+
+* Python (>= 3.10)
+
+API Usage
+---------
+
+You can install *Renault API* via pip_ from PyPI_:
+
+.. code:: console
+
+   $ pip install renault-api
+
+.. code:: python
+
+   import aiohttp
+   import asyncio
+
+   from renault_api.renault_client import RenaultClient
+
+   async def main():
+      async with aiohttp.ClientSession() as websession:
+         client = RenaultClient(websession=websession, locale="fr_FR")
+         await client.session.login('email', 'password')
+         print(f"Accounts: {await client.get_person()}") # List available accounts, make a note of kamereon account id
+
+         account_id = "Your Kamereon account id"
+         account = await client.get_api_account(account_id)
+         print(f"Vehicles: {await account.get_vehicles()}") # List available vehicles, make a note of vehicle VIN
+
+         vin = "Your vehicle VIN"
+         vehicle = await account.get_api_vehicle(vin)
+         print(f"Cockpit information: {await vehicle.get_cockpit()}")
+         print(f"Battery status information: {await vehicle.get_battery_status()}")
+
+   loop = asyncio.get_event_loop()
+   loop.run_until_complete(main())
+
+CLI Usage
+---------
+
+The renault-api is also available through a CLI, which requires additional dependencies.
+For the added dependencies, you can install *Renault API* via pip_ from PyPI_:
+
+.. code:: console
+
+   $ pip install renault-api[cli]
+
+Once installed, the following command prompts for credentials and settings, displays basic vehicle status information, and generates traces:
+
+.. code:: console
+
+   $ renault-api --log status
+
+* Credentials will automatically be stored in the user home directory (~/.credentials/renault-api.json)
+* Logs will automatically be generated in `logs` subfolder
+
+It is also possible to use raw http GET/POST commands, for example to get odometer and others data on a Windows machine:
+
+.. code:: console
+
+  C:> renault-api http get /commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/cockpit
+
+Or to request a battery status refresh on a Windows Machine (internal quotes escaped, whole payload enclosed in un-escaped quotes):
+
+.. code:: console
+
+  C:> renault-api http post /commerce/v1/accounts/{account_id}/kamereon/kca/car-adapter/v1/cars/{vin}/actions/refresh-battery-status "{\\"data\\": {\\"type\\": \\"RefreshBatteryStatus\\"}}"
+
+Please see the `Command-line Reference <Usage_>`_ for full details.
+
+Contributing
+------------
+
+Contributions are very welcome.
+To learn more, see the `Contributor Guide`_.
+
+
+License
+-------
+
+Distributed under the terms of the MIT_ license,
+*Renault API* is free and open source software.
+
+
+Disclaimer
+----------
+
+This project is not affiliated with, endorsed by, or connected to Renault. I accept no responsibility for any consequences, intended or accidental, as a as a result of interacting with Renault's API using this project.
+
+
+Issues
+------
+
+If you encounter any problems,
+please `file an issue`_ along with a detailed description.
+
+
+Credits
+-------
+
+This project was generated from `@cjolowicz`_'s `Hypermodern Python Cookiecutter`_ template.
+This project was heavily based on `@jamesremuscat`_'s `PyZE`_ python client for the Renault ZE API.
+
+
+.. _@cjolowicz: https://github.com/cjolowicz
+.. _Cookiecutter: https://github.com/audreyr/cookiecutter
+.. _@jamesremuscat: https://github.com/jamesremuscat
+.. _PyZE: https://github.com/jamesremuscat/pyze
+.. _MIT: http://opensource.org/licenses/MIT
+.. _PyPI: https://pypi.org/
+.. _Hypermodern Python Cookiecutter: https://github.com/cjolowicz/cookiecutter-hypermodern-python
+.. _file an issue: https://github.com/hacf-fr/renault-api/issues
+.. _pip: https://pip.pypa.io/
+.. github-only
+.. _Contributor Guide: CONTRIBUTING.rst
+.. _Usage: https://renault-api.readthedocs.io/en/latest/usage.html

renault_api-0.5.1/pyproject.toml

@@ -0,0 +1,157 @@
+[tool.poetry]
+name = "renault-api"
+version = "0.5.1"
+description = "Renault API"
+authors = ["epenet"]
+license = "MIT"
+readme = "README.rst"
+homepage = "https://github.com/hacf-fr/renault-api"
+repository = "https://github.com/hacf-fr/renault-api"
+documentation = "https://renault-api.readthedocs.io"
+classifiers = [
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+
+[tool.poetry.urls]
+Changelog = "https://github.com/hacf-fr/renault-api/releases"
+
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
+
+[tool.poetry.dependencies]
+python = ">=3.10,<4.0"
+# Warning: as of 2024-04-23, aiohttp is pinned to 3.9.5 on HA-core
+aiohttp = ">=3.9.5"
+# Warning: as of 2023-07-19, pyjwt is pinned to 2.8.0 on HA-core
+PyJWT = ">=2.8.0"
+#ensure cryptography (for pyjwt) is greater than 44.0.0 to account for CVE-2024-12797
+cryptography = ">=44.0.0"
+#ensure cffi (for cryptography) is greater than 1.17.0 for python 3.13 compatibility
+cffi = ">=1.17.0"
+
+marshmallow-dataclass = ">=8.2.0"
+click = { version = ">=8.0.1", optional = true }
+tabulate = { version = ">=0.8.7", optional = true }
+dateparser = {version = ">=1.0.0", optional = true}
+#ensure six (for dateparser) is greater than 1.16 for python 3.12 compatibility
+six = {version = "^1.16", optional = true}
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">=7.3.1,<10.0.0"
+coverage = {extras = ["toml"], version = "^7.2"}
+safety = ">=2.3.5,<4.0.0"
+mypy = "^1.2"
+typeguard = ">=4.1.3,<5.0.0"
+xdoctest = {extras = ["colors"], version = "^1.1.1"}
+sphinx = ">=4.3.2,<9.0.0"
+sphinx-autobuild = ">=2021.3.14,<2025.0.0"
+pre-commit = ">=2.21,<5.0"
+ruff = ">=0.3.7"
+darglint = "^1.8.1"
+pre-commit-hooks = ">=4.4,<7.0"
+sphinx-rtd-theme = ">=1.2,<4.0"
+sphinx-click = ">=4.4,<7.0"
+Pygments = "^2.15.0"
+pytest-asyncio = ">=0.21,<1.4"
+aioresponses = "^0.7.4"
+pytest-cov = ">=4,<8"
+syrupy = ">=4.9.1"
+#ensure urllib3 (for requests/sphinx) is greater than 1.26.5 to account for CVE-2021-33503
+urllib3 = ">=1.26.15,<3.0.0"
+#ensure certifi (for requests/sphinx) is greater than 2023.7.22 to account for CVE-2023-37920
+certifi = ">=2023.7.22,<2026.0.0"
+#ensure requests (for sphinx) is greater than 2.31.0 to account for CVE-2023-32681
+requests = "^2.31.0"
+#ensure tornado (for sphinx) is greater than 6.3.3 to account for GHSA-qppv-j76h-2rpx
+tornado = "^6.3.3"
+#ensure PyYAML (for sphinx) is greater than 6.0.1 to fix Cython wheel
+PyYAML = "^6.0.1"
+#ensure virtualenv (for pre-commit) is greater than 20.21.0 to account for PVE-2024-68477
+virtualenv = ">=20.21.0"
+#ensure nodeenv (for pre-commit) is greater than 1.9.0 for python 3.13 compatibility
+nodeenv = ">=1.9.0"
+#ensure typing-extensions (for safety>pydantic) is greater than 4.12.2 for python 3.13 compatibility
+typing-extensions = ">=4.12.2"
+
+[tool.poetry.extras]
+cli = ["click", "tabulate", "dateparser"]
+
+[tool.poetry.scripts]
+renault-api = "renault_api.cli.__main__:main"
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+
+[tool.coverage.run]
+branch = true
+source = ["renault_api"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.mypy]
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+no_implicit_reexport = true
+pretty = true
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+strict_equality = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unreachable = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.ruff.lint]
+ignore = [
+    "A001",    # Variable is shadowing a Python builtin
+    "A002",    # Argument is shadowing a Python builtin
+    "N815",    # Variable in class scope should not be mixedCase
+    "PLR0911", # Too many return statements
+    "PLR0913", # Too many arguments in function definition
+]
+select = [
+    "A",     # flake8-builtins
+    "B",     # flake8-bugbear
+    "C4",    # flake8-comprehensions
+    "C90",   # mccabe
+    "E",     # pycodestyle error
+    "ERA",   # eradicate
+    "F",     # Pyflakes
+    "I",     # isort
+    "N",     # pep8-naming
+    "PL",    # Pylint
+    "PT",    # flake8-pytest-style
+    "UP",    # pyupgrade
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+known-local-folder = [
+    "renault_api",
+]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 10
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

renault_api-0.5.1/src/renault_api/__init__.py

@@ -0,0 +1 @@
+"""Renault API."""

renault_api-0.5.1/src/renault_api/cli/__init__.py

@@ -0,0 +1 @@
+"""Renault CLI."""