myskoda 0.0.0__tar.gz

myskoda-0.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2024 Frederick Gnodtke
+
+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.

myskoda-0.0.0/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.1
+Name: myskoda
+Version: 0.0.0
+Summary: Library for interaction with the MySkoda APIs.
+Author: Frederick Gnodtke
+Author-email: frederick@gnodtke.net
+Requires-Python: >=3.12.0,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: cli
+Provides-Extra: docs
+Requires-Dist: aiohttp (>=3,<4)
+Requires-Dist: aiomqtt (>=2.0,<3.0)
+Requires-Dist: asyncclick (>=8.1.7.2,<9.0.0.0) ; extra == "cli"
+Requires-Dist: asyncio (>=3,<4)
+Requires-Dist: coloredlogs (>=15.0.1,<16.0.0) ; extra == "cli"
+Requires-Dist: mashumaro[orjson] (>=3.13.1,<4.0.0)
+Requires-Dist: mkdocs-gen-files (>=0.5.0,<0.6.0) ; extra == "docs"
+Requires-Dist: mkdocs-literate-nav (>=0.6.1,<0.7.0) ; extra == "docs"
+Requires-Dist: mkdocs[gen-files] (>=1.6.1,<2.0.0) ; extra == "docs"
+Requires-Dist: mkdocstrings[python] (>=0.26.1,<0.28.0) ; extra == "docs"
+Requires-Dist: paho-mqtt (>=1,<2)
+Requires-Dist: pygments (>=2.18.0,<3.0.0) ; extra == "cli"
+Requires-Dist: pyjwt (>=2,<3)
+Requires-Dist: pyyaml (>=6,<7)
+Requires-Dist: termcolor (>=2.4.0,<3.0.0) ; extra == "cli"
+Description-Content-Type: text/markdown
+
+[![Version](https://img.shields.io/github/v/release/skodaconnect/myskoda?include_prereleases)](https://github.com/skodaconnect/myskoda/releases)
+[![PyPi](https://img.shields.io/pypi/v/myskoda?label=latest%20pypi)](https://pypi.org/project/myskoda/)
+[![Downloads PyPi](https://img.shields.io/pypi/dm/myskoda)](https://pypi.org/project/myskoda/)
+[![Docs](https://readthedocs.org/projects/myskoda/badge/?version=latest)](https://myskoda.readthedocs.io/en/latest/)
+[![Discord](https://img.shields.io/discord/877164727636230184)](https://discord.gg/t7az2hSJXq)
+[![Coverage Status](https://coveralls.io/repos/github/skodaconnect/myskoda/badge.svg)](https://coveralls.io/github/skodaconnect/myskoda)
+
+# MySkoda
+
+This Python library can be used to work with the MySkoda API.
+<!-- TOC -->
+
+- [MySkoda](#myskoda)
+  - [Get In Touch](#get-in-touch)
+  - [Quick Start](#quick-start)
+    - [Basic example](#basic-example)
+  - [Documentation](#documentation)
+  - [As Library](#as-library)
+  - [As CLI](#as-cli)
+  - [Contribute your Fixtures](#contribute-your-fixtures)
+  - [Disclaimer](#disclaimer)
+
+<!-- /TOC -->
+
+## Get In Touch
+
+We have an active community in our discord. [Feel free to join](https://discord.gg/t7az2hSJXq).
+
+If you have any issues, please report them in our issue tracker.
+
+## Quick Start
+
+The MySkoda package is published to Pypi and can be found [here](https://pypi.org/project/myskoda/).
+
+It can be installed the usual way:
+
+```sh
+pip install myskoda
+```
+
+### Basic example
+
+```python
+from aiohttp import ClientSession
+from myskoda import MySkoda
+
+session = ClientSession()
+myskoda = MySkoda(session)
+await myskoda.connect(email, password)
+
+for vin in await myskoda.list_vehicle_vins():
+    print(vin)
+
+myskoda.disconnect()
+await session.close()
+```
+
+## Documentation
+
+Detailed documentation [is available at read the docs](https://myskoda.readthedocs.io/en/latest/):
+* [Fetching Data](https://myskoda.readthedocs.io/en/latest/fetching_data/)
+* [Subscribing to Events](https://myskoda.readthedocs.io/en/latest/events/)
+* [Primer](https://myskoda.readthedocs.io/en/latest/primer/)
+
+## As Library
+
+MySkoda relies on [aiohttp](https://pypi.org/project/aiohttp/) which must be installed.
+A `ClientSession` must be opened and passed to `MySkoda` upon initialization.
+
+After connecting, operations can be performed, events can be subscribed to and data can be loaded from the API.
+
+Don't forget to close the session and disconnect MySkoda after you're done.
+
+## As CLI
+
+The MySkoda package features a CLI.
+You will have to install it with extras `cli`:
+
+```sh
+pip install "myskoda[cli]"
+```
+
+Afterwards, the CLI is available in your current environment by invoking `myskoda`.
+
+Username and password must be provided to the CLI for every request as options, before selecting a sub command:
+
+```sh
+myskoda --user "user@example.com" --password "super secret" list-vehicles
+```
+
+Help can be accessed the usual way:
+
+```sh
+myskoda --help
+```
+
+## Contribute your Fixtures
+
+Please contribute fixtures for our tests by running this command:
+
+```sh
+# Export all endpoints for all vehicles.
+myskoda \
+    --user user \
+    --password password \
+    gen-fixtures \
+        --name my_cars \
+        --description "My cars in no specific state."
+        --vehicle all \
+        get all
+```
+
+It is also possible to just contribute a single vehicle:
+
+```sh
+# Export all endpoints for a specific vehicle.
+myskoda \
+    --user user \
+    --password password \
+    gen-fixtures \
+        --name my_favorite_car \
+        --description "My favorite car in no specific state."
+        --vehicle TMOCKAA0AA000000 \
+        get all
+```
+
+Or even narrow down to an inidividual endpoint for an individual vehicle:
+
+```sh
+# Export a specific endpoint for a specific vehicle.
+myskoda \
+    --user user \
+    --password password \
+    gen-fixtures \
+        --name my_favorite_car_info \
+        --description "Info for my favorite car in no specific state."
+        --vehicle TMOCKAA0AA000000 \
+        get info
+```
+
+This will call all the selected get-routes and load all data from your vehicles (no actions will be performed).
+
+The data will be anonymized (vin and personal data are replaced) and serves as unit tests.
+
+Please create a pull request with the resulting data to help us cover more vehicles.
+
+## Disclaimer
+
+This project is an unofficial API client for the Skoda API and is not affiliated with, endorsed by, or associated with Skoda Auto or any of its subsidiaries.
+
+Use this project at your own risk. Skoda Auto may update or modify its API without notice, which could render this client inoperative or non-compliant. The maintainers of this project are not responsible for any misuse, legal implications, or damages arising from its use.
+
+Ensure compliance with Skoda Auto's terms of service and any applicable laws when using this software.
+

myskoda-0.0.0/README.md

@@ -0,0 +1,153 @@
+[![Version](https://img.shields.io/github/v/release/skodaconnect/myskoda?include_prereleases)](https://github.com/skodaconnect/myskoda/releases)
+[![PyPi](https://img.shields.io/pypi/v/myskoda?label=latest%20pypi)](https://pypi.org/project/myskoda/)
+[![Downloads PyPi](https://img.shields.io/pypi/dm/myskoda)](https://pypi.org/project/myskoda/)
+[![Docs](https://readthedocs.org/projects/myskoda/badge/?version=latest)](https://myskoda.readthedocs.io/en/latest/)
+[![Discord](https://img.shields.io/discord/877164727636230184)](https://discord.gg/t7az2hSJXq)
+[![Coverage Status](https://coveralls.io/repos/github/skodaconnect/myskoda/badge.svg)](https://coveralls.io/github/skodaconnect/myskoda)
+
+# MySkoda
+
+This Python library can be used to work with the MySkoda API.
+<!-- TOC -->
+
+- [MySkoda](#myskoda)
+  - [Get In Touch](#get-in-touch)
+  - [Quick Start](#quick-start)
+    - [Basic example](#basic-example)
+  - [Documentation](#documentation)
+  - [As Library](#as-library)
+  - [As CLI](#as-cli)
+  - [Contribute your Fixtures](#contribute-your-fixtures)
+  - [Disclaimer](#disclaimer)
+
+<!-- /TOC -->
+
+## Get In Touch
+
+We have an active community in our discord. [Feel free to join](https://discord.gg/t7az2hSJXq).
+
+If you have any issues, please report them in our issue tracker.
+
+## Quick Start
+
+The MySkoda package is published to Pypi and can be found [here](https://pypi.org/project/myskoda/).
+
+It can be installed the usual way:
+
+```sh
+pip install myskoda
+```
+
+### Basic example
+
+```python
+from aiohttp import ClientSession
+from myskoda import MySkoda
+
+session = ClientSession()
+myskoda = MySkoda(session)
+await myskoda.connect(email, password)
+
+for vin in await myskoda.list_vehicle_vins():
+    print(vin)
+
+myskoda.disconnect()
+await session.close()
+```
+
+## Documentation
+
+Detailed documentation [is available at read the docs](https://myskoda.readthedocs.io/en/latest/):
+* [Fetching Data](https://myskoda.readthedocs.io/en/latest/fetching_data/)
+* [Subscribing to Events](https://myskoda.readthedocs.io/en/latest/events/)
+* [Primer](https://myskoda.readthedocs.io/en/latest/primer/)
+
+## As Library
+
+MySkoda relies on [aiohttp](https://pypi.org/project/aiohttp/) which must be installed.
+A `ClientSession` must be opened and passed to `MySkoda` upon initialization.
+
+After connecting, operations can be performed, events can be subscribed to and data can be loaded from the API.
+
+Don't forget to close the session and disconnect MySkoda after you're done.
+
+## As CLI
+
+The MySkoda package features a CLI.
+You will have to install it with extras `cli`:
+
+```sh
+pip install "myskoda[cli]"
+```
+
+Afterwards, the CLI is available in your current environment by invoking `myskoda`.
+
+Username and password must be provided to the CLI for every request as options, before selecting a sub command:
+
+```sh
+myskoda --user "user@example.com" --password "super secret" list-vehicles
+```
+
+Help can be accessed the usual way:
+
+```sh
+myskoda --help
+```
+
+## Contribute your Fixtures
+
+Please contribute fixtures for our tests by running this command:
+
+```sh
+# Export all endpoints for all vehicles.
+myskoda \
+    --user user \
+    --password password \
+    gen-fixtures \
+        --name my_cars \
+        --description "My cars in no specific state."
+        --vehicle all \
+        get all
+```
+
+It is also possible to just contribute a single vehicle:
+
+```sh
+# Export all endpoints for a specific vehicle.
+myskoda \
+    --user user \
+    --password password \
+    gen-fixtures \
+        --name my_favorite_car \
+        --description "My favorite car in no specific state."
+        --vehicle TMOCKAA0AA000000 \
+        get all
+```
+
+Or even narrow down to an inidividual endpoint for an individual vehicle:
+
+```sh
+# Export a specific endpoint for a specific vehicle.
+myskoda \
+    --user user \
+    --password password \
+    gen-fixtures \
+        --name my_favorite_car_info \
+        --description "Info for my favorite car in no specific state."
+        --vehicle TMOCKAA0AA000000 \
+        get info
+```
+
+This will call all the selected get-routes and load all data from your vehicles (no actions will be performed).
+
+The data will be anonymized (vin and personal data are replaced) and serves as unit tests.
+
+Please create a pull request with the resulting data to help us cover more vehicles.
+
+## Disclaimer
+
+This project is an unofficial API client for the Skoda API and is not affiliated with, endorsed by, or associated with Skoda Auto or any of its subsidiaries.
+
+Use this project at your own risk. Skoda Auto may update or modify its API without notice, which could render this client inoperative or non-compliant. The maintainers of this project are not responsible for any misuse, legal implications, or damages arising from its use.
+
+Ensure compliance with Skoda Auto's terms of service and any applicable laws when using this software.

myskoda-0.0.0/myskoda/__init__.py

@@ -0,0 +1,50 @@
+"""A library for interacting with the MySkoda APIs."""
+
+from .__version__ import __version__
+from .auth.authorization import (
+    Authorization,
+    AuthorizationError,
+    AuthorizationFailedError,
+    IDKAuthorizationCode,
+    IDKSession,
+)
+from .models import (
+    air_conditioning,
+    charging,
+    common,
+    health,
+    info,
+    operation_request,
+    position,
+    service_event,
+    status,
+    user,
+)
+from .mqtt import MySkodaMqttClient
+from .myskoda import TRACE_CONFIG, MySkoda
+from .rest_api import RestApi
+from .vehicle import Vehicle
+
+__all__ = [
+    "TRACE_CONFIG",
+    "Authorization",
+    "AuthorizationError",
+    "AuthorizationFailedError",
+    "IDKAuthorizationCode",
+    "IDKSession",
+    "MySkoda",
+    "MySkodaMqttClient",
+    "RestApi",
+    "Vehicle",
+    "__version__",
+    "air_conditioning",
+    "charging",
+    "common",
+    "health",
+    "info",
+    "operation_request",
+    "position",
+    "service_event",
+    "status",
+    "user",
+]

myskoda-0.0.0/myskoda/__version__.py

@@ -0,0 +1,3 @@
+"""Version for MySkoda package. Used for dynamic versioning with poetry."""
+
+__version__ = "0.0.0"

myskoda-0.0.0/myskoda/anonymize.py

@@ -0,0 +1,132 @@
+"""Methods for anonymizing data from the API."""
+
+import re
+
+ACCESS_TOKEN = "eyJ0eXAiOiI0ODEyODgzZi05Y2FiLTQwMWMtYTI5OC0wZmEyMTA5Y2ViY2EiLCJhbGciOiJSUzI1NiJ9"  # noqa: S105
+USER_ID = "b8bc126c-ee36-402b-8723-2c1c3dff8dec"
+VIN = "TMOCKAA0AA000000"
+VIN_REGEX = re.compile(r"TMB\w{14}")
+ADDRESS = {
+    "city": "Example City",
+    "street": "Example Avenue",
+    "houseNumber": "15",
+    "zipCode": "54321",
+    "countryCode": "DEU",
+}
+SERVICE_PARTNER_ID = "DEU11111"
+PARTNER_NUMBER = "1111"
+PARTNER_NAME = "Example Service Partner"
+LOCATION = {
+    "latitude": 53.470636,
+    "longitude": 9.689872,
+}
+EMAIL = "user@example.com"
+PHONE = "+49 1234 567890"
+VEHICLE_NAME = "Example Car"
+LICENSE_PLATE = "HH AA 1234"
+URL = "https://example.com"
+FIRST_NAME = "John"
+LAST_NAME = "Dough"
+NICKNAME = "Johnny D."
+PROFILE_PICTURE_URL = "https://example.com/profile.jpg"
+DATE_OF_BIRTH = "2000-01-01"
+
+SERVICE_PARTNER = {
+    "name": PARTNER_NAME,
+    "partnerNumber": PARTNER_NUMBER,
+    "id": SERVICE_PARTNER_ID,
+    "contact": {
+        "phone": PHONE,
+        "url": URL,
+        "email": EMAIL,
+    },
+    "address": ADDRESS,
+    "location": LOCATION,
+}
+
+
+def anonymize_info(data: dict) -> dict:
+    data["vin"] = VIN
+    data["name"] = VEHICLE_NAME
+    if "licensePlate" in data:
+        data["licensePlate"] = LICENSE_PLATE
+    if "servicePartner" in data:
+        data["servicePartner"]["servicePartnerId"] = SERVICE_PARTNER_ID
+    return data
+
+
+def anonymize_maintenance(data: dict) -> dict:
+    if "preferredServicePartner" in data:
+        data["preferredServicePartner"].update(SERVICE_PARTNER)
+    if "predictiveMaintenance" in data:
+        data["predictiveMaintenance"]["setting"]["email"] = EMAIL
+        data["predictiveMaintenance"]["setting"]["phone"] = PHONE
+    for booking in data.get("customerService", {}).get("bookingHistory", []):
+        booking["servicePartner"].update(SERVICE_PARTNER)
+    for booking in data.get("customerService", {}).get("bookingHistory", []):
+        booking["servicePartner"].update(SERVICE_PARTNER)
+    return data
+
+
+def anonymize_charging(data: dict) -> dict:
+    return data
+
+
+def anonymize_status(data: dict) -> dict:
+    return data
+
+
+def anonymize_air_conditioning(data: dict) -> dict:
+    return data
+
+
+def anonymize_auxiliary_heating(data: dict) -> dict:
+    return data
+
+
+def anonymize_positions(data: dict) -> dict:
+    if "positions" in data:
+        for position in data["positions"]:
+            position["gpsCoordinates"] = LOCATION
+            position["address"] = ADDRESS
+    return data
+
+
+def anonymize_driving_range(data: dict) -> dict:
+    return data
+
+
+def anonymize_trip_statistics(data: dict) -> dict:
+    return data
+
+
+def anonymize_health(data: dict) -> dict:
+    return data
+
+
+def anonymize_user(data: dict) -> dict:
+    data["email"] = EMAIL
+    data["firstName"] = FIRST_NAME
+    data["lastName"] = LAST_NAME
+    data["nickname"] = NICKNAME
+    data["profilePictureUrl"] = PROFILE_PICTURE_URL
+    data["dateOfBirth"] = DATE_OF_BIRTH
+    data["phone"] = PHONE
+
+    return data
+
+
+def anonymize_garage_entry(data: dict) -> dict:
+    data["vin"] = VIN
+    data["name"] = VEHICLE_NAME
+    return data
+
+
+def anonymize_garage(data: dict) -> dict:
+    if "vehicles" in data:
+        data["vehicles"] = [anonymize_garage_entry(vehicle) for vehicle in data["vehicles"]]
+    return data
+
+
+def anonymize_url(url: str) -> str:
+    return VIN_REGEX.sub(VIN, url)

myskoda-0.0.0/myskoda/auth/__init__.py

@@ -0,0 +1 @@
+"""Authorization for VW IDK servers."""