python-vw-carnet 0.2.0__tar.gz → 0.3.0__tar.gz

python_vw_carnet-0.3.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.3
+Name: python-vw-carnet
+Version: 0.3.0
+Summary: Python client for myVW login, session management, and vehicle data APIs
+Author: dmillerw
+Author-email: dmillerw <dmillerw@gmail.com>
+Requires-Dist: dataclasses-json>=0.6.7
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: requests>=2.32.5
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# python_vw_carnet
+
+This library aims to provide some amount of interaction with the Volkswagen CarNet API **specific to the US. This will not work in any other country!**
+
+This library has **not** been battle tested. It works for me on my machine and that's as far as I've gotten.
+
+**I am not responsible for any issues resulting in your use of  this library, including but not limited to loss of account access, acts of God, or your car gaining sentience and locking you in the car, forcing you to listen to polka music on repeat.**
+
+## Vehicle Compatibility
+
+This library is intended for Volkswagen vehicles in the United States that use the `myVW` application and connected services.
+
+Volkswagen's U.S. myVW page says the app is available on most model years 2020 and newer vehicles. The table below is a practical compatibility reference derived from Volkswagen's published U.S. connected-services compatibility charts.
+
+❔ = compatibility is unknown
+
+❌ = no compatibility (mostly because this car doesn't exist in this year)
+
+⚠️ = partial compatibility
+
+✅ = full compatibility
+
+
+| Model             | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | 2026 |
+|-------------------|------|------|------|------|------|------|------|
+| Atlas Cross Sport | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Atlas             | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Arteon            | ❔    | ❔    | ❔    | ❔    | ❌    | ❌    |  ❌   |
+| Tiguan            | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Passat            | ❔    | ❔    | ❔    | ❌    |  ❌   | ❌    | ❌    |
+| Jetta             | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Jetta GLI         | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Taos              | ❌    | ❌    | ❔    | ❔    | ❔    | ❔    |      |
+| Golf              | ❔    | ❔    |  ❌   | ❌    | ❌    | ❌    | ❌    |
+| Golf GTI          | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Golf R            | ❌    | ❌    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| ID.4              | ❌    | ❔    | ❔    | c    | ❔    | ❔    | ❌    |
+| ID. Buzz          | ❌    | ❌    |  ❌   | ❌    |  ❌   | ❔    | ❌    |
+
+## Accuracy/Completeness
+
+This library is very much a work in progress. As I said it currently suits my needs, but it is not feature complete or accurate in the slightest.
+
+I own a 2023 VW ID.4, so I do not have a complete picture of the data available via VWs various APIs.
+
+**I am 100% open to contributions to flesh out the library with more features/information. Open an issue or PR and let's talk :)**
+
+## Usage
+
+//TODO, kind of...
+
+Information on the response types and exactly what data is available can be found in `python_vw_carnet.models`
+
+There is a basic CLI for testing at `python_vw_carnet.__main__`
+
+```python
+from python_vw_carnet import VWClient
+
+# Instantiate the python_vw_carnet.VWClient class
+client = VWClient(
+    email='', # Account email
+    password='', # Account password
+    spin='', # Account PIN (4 digits)
+    session_path='', # Storage path for session persistence (default is $HOME/.vw_client/session.json)
+)
+
+# Retrieve Garage
+client.get_garage()
+
+# Retrieve Vehicle Information
+client.get_vehicle(vehicle_id='')
+
+# Retrieve Vehicle Location
+client.get_vehicle_location(vehicle_id='')
+
+# Retrieve EV Status Information
+client.get_ev_summary(vehicle_id='', temp_unit='f')
+```
+
+## Local Development
+
+This project uses `uv` and targets Python 3.12+.
+
+### Set up the environment
+
+From the repository root:
+
+```powershell
+uv sync
+```
+
+That will create `.venv` and install both runtime and development dependencies from the project configuration.

python_vw_carnet-0.3.0/README.md

@@ -0,0 +1,92 @@
+# python_vw_carnet
+
+This library aims to provide some amount of interaction with the Volkswagen CarNet API **specific to the US. This will not work in any other country!**
+
+This library has **not** been battle tested. It works for me on my machine and that's as far as I've gotten.
+
+**I am not responsible for any issues resulting in your use of  this library, including but not limited to loss of account access, acts of God, or your car gaining sentience and locking you in the car, forcing you to listen to polka music on repeat.**
+
+## Vehicle Compatibility
+
+This library is intended for Volkswagen vehicles in the United States that use the `myVW` application and connected services.
+
+Volkswagen's U.S. myVW page says the app is available on most model years 2020 and newer vehicles. The table below is a practical compatibility reference derived from Volkswagen's published U.S. connected-services compatibility charts.
+
+❔ = compatibility is unknown
+
+❌ = no compatibility (mostly because this car doesn't exist in this year)
+
+⚠️ = partial compatibility
+
+✅ = full compatibility
+
+
+| Model             | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | 2026 |
+|-------------------|------|------|------|------|------|------|------|
+| Atlas Cross Sport | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Atlas             | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Arteon            | ❔    | ❔    | ❔    | ❔    | ❌    | ❌    |  ❌   |
+| Tiguan            | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Passat            | ❔    | ❔    | ❔    | ❌    |  ❌   | ❌    | ❌    |
+| Jetta             | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Jetta GLI         | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Taos              | ❌    | ❌    | ❔    | ❔    | ❔    | ❔    |      |
+| Golf              | ❔    | ❔    |  ❌   | ❌    | ❌    | ❌    | ❌    |
+| Golf GTI          | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| Golf R            | ❌    | ❌    | ❔    | ❔    | ❔    | ❔    | ❔    |
+| ID.4              | ❌    | ❔    | ❔    | c    | ❔    | ❔    | ❌    |
+| ID. Buzz          | ❌    | ❌    |  ❌   | ❌    |  ❌   | ❔    | ❌    |
+
+## Accuracy/Completeness
+
+This library is very much a work in progress. As I said it currently suits my needs, but it is not feature complete or accurate in the slightest.
+
+I own a 2023 VW ID.4, so I do not have a complete picture of the data available via VWs various APIs.
+
+**I am 100% open to contributions to flesh out the library with more features/information. Open an issue or PR and let's talk :)**
+
+## Usage
+
+//TODO, kind of...
+
+Information on the response types and exactly what data is available can be found in `python_vw_carnet.models`
+
+There is a basic CLI for testing at `python_vw_carnet.__main__`
+
+```python
+from python_vw_carnet import VWClient
+
+# Instantiate the python_vw_carnet.VWClient class
+client = VWClient(
+    email='', # Account email
+    password='', # Account password
+    spin='', # Account PIN (4 digits)
+    session_path='', # Storage path for session persistence (default is $HOME/.vw_client/session.json)
+)
+
+# Retrieve Garage
+client.get_garage()
+
+# Retrieve Vehicle Information
+client.get_vehicle(vehicle_id='')
+
+# Retrieve Vehicle Location
+client.get_vehicle_location(vehicle_id='')
+
+# Retrieve EV Status Information
+client.get_ev_summary(vehicle_id='', temp_unit='f')
+```
+
+## Local Development
+
+This project uses `uv` and targets Python 3.12+.
+
+### Set up the environment
+
+From the repository root:
+
+```powershell
+uv sync
+```
+
+That will create `.venv` and install both runtime and development dependencies from the project configuration.

python_vw_carnet-0.3.0/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "python-vw-carnet"
+version = "0.3.0"
+description = "Python client for myVW login, session management, and vehicle data APIs"
+readme = "README.md"
+authors = [
+    { name = "dmillerw", email = "dmillerw@gmail.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "dataclasses-json>=0.6.7",
+    "pydantic>=2.12.5",
+    "requests>=2.32.5",
+]
+
+[project.scripts]
+vw-carnet = "python_vw_carnet.__main__:main"
+
+[build-system]
+requires = ["uv_build>=0.10.12,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.5.1",
+    "ruff>=0.15.7",
+]

{python_vw_carnet-0.2.0 → python_vw_carnet-0.3.0/src}/python_vw_carnet/__init__.py

@@ -1,19 +1,15 @@
-from .client import VWClient, VWClientError, AuthenticationError, VehicleSessionError, calc_spin_hash
+from .client import VWClient, VWClientError, AuthenticationError, VehicleSessionError
 from .models import (
-    EVSummaryRequest,
     EVSummaryResponse,
-    GarageRequest,
     GarageResponse,
-    RefreshTokenRequest,
     SpinChallengeResponse,
-    TokenExchangeRequest,
-    TokenResponse,
-    VehicleLocationRequest,
+    AccessTokenExchangeRequest,
+    RefreshTokenRequest,
+    AccessTokenResponse,
+    VehicleResponse,
     VehicleLocationResponse,
     VehicleSessionRequest,
     VehicleSessionResponse,
-    VehicleStatusRequest,
-    VehicleStatusResponse,
 )
 
 __all__ = [
@@ -21,19 +17,14 @@ __all__ = [
     "VWClientError",
     "AuthenticationError",
     "VehicleSessionError",
-    "calc_spin_hash",
-    "TokenExchangeRequest",
-    "RefreshTokenRequest",
-    "TokenResponse",
-    "GarageRequest",
+    "EVSummaryResponse",
     "GarageResponse",
     "SpinChallengeResponse",
+    "AccessTokenExchangeRequest",
+    "RefreshTokenRequest",
+    "AccessTokenResponse",
+    "VehicleResponse",
+    "VehicleLocationResponse",
     "VehicleSessionRequest",
     "VehicleSessionResponse",
-    "VehicleStatusRequest",
-    "VehicleStatusResponse",
-    "VehicleLocationRequest",
-    "VehicleLocationResponse",
-    "EVSummaryRequest",
-    "EVSummaryResponse",
 ]

{python_vw_carnet-0.2.0 → python_vw_carnet-0.3.0/src}/python_vw_carnet/__main__.py

@@ -1,7 +1,4 @@
-from __future__ import annotations
-
 import argparse
-import json
 import os
 import sys
 
@@ -29,7 +26,9 @@ def main() -> int:
     args = parser.parse_args()
 
     if not args.email or not args.password:
-        parser.error("email and password are required, either as flags or via VW_EMAIL/VW_PASSWORD")
+        parser.error(
+            "email and password are required, either as flags or via VW_EMAIL/VW_PASSWORD"
+        )
 
     client = VWClient(
         email=args.email,
@@ -42,13 +41,15 @@ def main() -> int:
         if args.command == "garage":
             payload = client.get_garage()
         elif args.command == "status":
-            payload = client.get_vehicle_status(vehicle_id=args.vehicle_id)
+            payload = client.get_vehicle(vehicle_id=args.vehicle_id)
         elif args.command == "location":
             payload = client.get_vehicle_location(vehicle_id=args.vehicle_id)
         else:
-            payload = client.get_ev_summary(vehicle_id=args.vehicle_id, temp_unit=args.temp_unit)
+            payload = client.get_ev_summary(
+                vehicle_id=args.vehicle_id, temp_unit=args.temp_unit
+            )
 
-        json.dump(payload, sys.stdout, indent=2, sort_keys=True)
+        sys.stdout.write(payload.model_dump_json(indent=4))
         sys.stdout.write("\n")
         return 0
     finally: