pyporscheconnectapi-bartolije 0.3.0__tar.gz

pyporscheconnectapi_bartolije-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Johan Isacsson
+
+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.

pyporscheconnectapi_bartolije-0.3.0/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: pyporscheconnectapi-bartolije
+Version: 0.3.0
+Summary: Python library and CLI for communicating with Porsche Connect API.
+Home-page: https://github.com/cjne/pyporscheconnectapi
+Author: Johan Isaksson
+Author-email: johan@generatorhallen.se
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiofiles
+Requires-Dist: httpx<1
+Requires-Dist: beautifulsoup4
+Requires-Dist: rich
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# pyporscheconnectapi
+A python library for Porsche Connect API
+
+This library will let you access your car equipped with Porsche Connect. It does not work with the predecessor Porsche Car Connect.
+Porsche Connect is available for the following Porsche models:
+
+* Boxster & Cayman (718)
+* 911 (from 992)
+* Taycan
+* Panamera (from 2021, G2 PA)
+* Macan (EV, from 2024)
+* Cayenne (from 2017, E3)
+
+You can also take a look here, select your model and see if your model has support for Porsche Connect:
+https://connect-store.porsche.com/
+
+A Porsche Connect subscription alse needs to be active for it to work.
+
+*NOTE:* This work is not officially supported by Porsche and functionality can stop working at any time without warning.
+
+## Installation
+
+The easiest method is to install using pip3/pip (venv is also a good idea).
+```
+pip install pyporscheconnectapi
+```
+
+to update to the latest version
+
+```
+pip install pyporscheconnectapi -U
+```
+
+Setup will add a cli under the name porschecli, see below for usage.
+
+
+## CLI usage
+
+A simple cli is provided with this library, it will cache tokens to a file to speed up invocations.
+
+If no email or password is supplied as input arguments and no config file with those details is found you will be prompted.
+```
+usage: porschecli [-h] [-d] [-j] [-e EMAIL] [-p PASSWORD] [-s SESSION_FILE] [--nowait]
+                  {list,token,capabilities,currentoverview,storedoverview,trip_statistics,pictures,location,climatise_on,climatise_off,direct_charge_on,direct_charge_off,flash_indicators,honk_and_flash,lock_vehicle,unlock_vehicle,vehicle_closed,doors_and_lids,tire_pressure_status,tire_pressures,chargingprofile}
+                  ...
+
+Porsche Connect CLI
+
+positional arguments:
+  {list,token,capabilities,currentoverview,storedoverview,trip_statistics,pictures,location,climatise_on,climatise_off,direct_charge_on,direct_charge_off,flash_indicators,honk_and_flash,lock_vehicle,unlock_vehicle,vehicle_closed,doors_and_lids,tire_pressure_status,tire_pressures,chargingprofile}
+                        command help
+    battery             Prints the main battery level (BEV)
+    capabilities        Get vehicle capabilities
+    chargingprofile     Update parameters in configured charging profile
+    climatise_off       Stop remote climatisation
+    climatise_on        Start remote climatisation
+    connected           Check if vehicle is on-line
+    currentoverview     Get stored overview for vehicle
+    direct_charge_off   Disable direct charging
+    direct_charge_on    Enable direct charging
+    doors_and_lids      List status of all doors and lids
+    flash_indicators    Flash indicators
+    honk_and_flash      Flash indicators and sound the horn
+    location            Show location of vehicle
+    lock_vehicle        Lock vehicle
+    pictures            Get vehicle pictures url
+    storedoverview      Poll vehicle for current overview
+    tire_status         Check if tire pressure are ok
+    tire_pressures      Get tire pressure readings
+    trip_statistics     Get trip statistics from backend
+    unlock_vehicle      Unlock vehicle
+    vehicle_closed      Check if all doors and lids are closed
+
+options:
+  -h, --help            show this help message and exit
+  -d, --debug
+  -j, --json            output in JSON format
+  -e EMAIL, --email EMAIL
+  -p PASSWORD, --password PASSWORD
+  -s SESSION_FILE, --sessionfile SESSION_FILE
+
+```
+
+## Config file (for CLI)
+
+A config file is searched for in ~/.porscheconnect.cfg and ./.porscheconnect.cfg
+The format is:
+
+```
+[porsche]
+email=<your email>
+password=<your password>
+session_file=<file to store session information>
+```
+
+## Library usage
+
+Install pyporscheconnectapi using pip (requires python >= 3.10)
+
+
+### Example client usage
+
+Please refer to the examples provided in the repository.

pyporscheconnectapi_bartolije-0.3.0/README.md

@@ -0,0 +1,103 @@
+# pyporscheconnectapi
+A python library for Porsche Connect API
+
+This library will let you access your car equipped with Porsche Connect. It does not work with the predecessor Porsche Car Connect.
+Porsche Connect is available for the following Porsche models:
+
+* Boxster & Cayman (718)
+* 911 (from 992)
+* Taycan
+* Panamera (from 2021, G2 PA)
+* Macan (EV, from 2024)
+* Cayenne (from 2017, E3)
+
+You can also take a look here, select your model and see if your model has support for Porsche Connect:
+https://connect-store.porsche.com/
+
+A Porsche Connect subscription alse needs to be active for it to work.
+
+*NOTE:* This work is not officially supported by Porsche and functionality can stop working at any time without warning.
+
+## Installation
+
+The easiest method is to install using pip3/pip (venv is also a good idea).
+```
+pip install pyporscheconnectapi
+```
+
+to update to the latest version
+
+```
+pip install pyporscheconnectapi -U
+```
+
+Setup will add a cli under the name porschecli, see below for usage.
+
+
+## CLI usage
+
+A simple cli is provided with this library, it will cache tokens to a file to speed up invocations.
+
+If no email or password is supplied as input arguments and no config file with those details is found you will be prompted.
+```
+usage: porschecli [-h] [-d] [-j] [-e EMAIL] [-p PASSWORD] [-s SESSION_FILE] [--nowait]
+                  {list,token,capabilities,currentoverview,storedoverview,trip_statistics,pictures,location,climatise_on,climatise_off,direct_charge_on,direct_charge_off,flash_indicators,honk_and_flash,lock_vehicle,unlock_vehicle,vehicle_closed,doors_and_lids,tire_pressure_status,tire_pressures,chargingprofile}
+                  ...
+
+Porsche Connect CLI
+
+positional arguments:
+  {list,token,capabilities,currentoverview,storedoverview,trip_statistics,pictures,location,climatise_on,climatise_off,direct_charge_on,direct_charge_off,flash_indicators,honk_and_flash,lock_vehicle,unlock_vehicle,vehicle_closed,doors_and_lids,tire_pressure_status,tire_pressures,chargingprofile}
+                        command help
+    battery             Prints the main battery level (BEV)
+    capabilities        Get vehicle capabilities
+    chargingprofile     Update parameters in configured charging profile
+    climatise_off       Stop remote climatisation
+    climatise_on        Start remote climatisation
+    connected           Check if vehicle is on-line
+    currentoverview     Get stored overview for vehicle
+    direct_charge_off   Disable direct charging
+    direct_charge_on    Enable direct charging
+    doors_and_lids      List status of all doors and lids
+    flash_indicators    Flash indicators
+    honk_and_flash      Flash indicators and sound the horn
+    location            Show location of vehicle
+    lock_vehicle        Lock vehicle
+    pictures            Get vehicle pictures url
+    storedoverview      Poll vehicle for current overview
+    tire_status         Check if tire pressure are ok
+    tire_pressures      Get tire pressure readings
+    trip_statistics     Get trip statistics from backend
+    unlock_vehicle      Unlock vehicle
+    vehicle_closed      Check if all doors and lids are closed
+
+options:
+  -h, --help            show this help message and exit
+  -d, --debug
+  -j, --json            output in JSON format
+  -e EMAIL, --email EMAIL
+  -p PASSWORD, --password PASSWORD
+  -s SESSION_FILE, --sessionfile SESSION_FILE
+
+```
+
+## Config file (for CLI)
+
+A config file is searched for in ~/.porscheconnect.cfg and ./.porscheconnect.cfg
+The format is:
+
+```
+[porsche]
+email=<your email>
+password=<your password>
+session_file=<file to store session information>
+```
+
+## Library usage
+
+Install pyporscheconnectapi using pip (requires python >= 3.10)
+
+
+### Example client usage
+
+Please refer to the examples provided in the repository.

pyporscheconnectapi_bartolije-0.3.0/pyporscheconnectapi/__init__.py

@@ -0,0 +1,10 @@
+"""Library to integrate with the Porsche Connect API.
+
+This library provides a Python interface to Porsche Connect API, with
+abilities to read vechicle status data and access to remote services
+to control certain vechicle functions.
+
+NOTE: This work is not officially supported by Porsche and functionality
+can stop working at any time without warning.
+
+"""

pyporscheconnectapi_bartolije-0.3.0/pyporscheconnectapi/account.py

@@ -0,0 +1,66 @@
+"""Accesses Porsche Connect account and retrieves connected vehicles."""
+
+from __future__ import annotations
+
+import logging
+
+from pyporscheconnectapi.connection import Connection
+from pyporscheconnectapi.vehicle import PorscheVehicle
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class PorscheConnectAccount:
+    """Establishes a connection to a Porsche Connect account."""
+
+    def __init__(
+        self,
+        username: str | None = None,
+        password: str | None = None,
+        token: dict | None = None,
+        connection: Connection | None = None,
+    ) -> None:
+        """Initialize the account."""
+        self.vehicles: list[PorscheVehicle] = []
+        self.token = token
+        if connection is None:
+            self.connection = Connection(username, password, token=token)
+        else:
+            self.connection = connection
+
+    async def _init_vehicles(self) -> None:
+        """Initialize vehicles from API endpoint."""
+        _LOGGER.debug("Building vehicle list")
+
+        if self.connection is not None:
+            vehicle_list = await self.connection.get("/connect/v1/vehicles")
+
+            for vehicle in vehicle_list:
+                _LOGGER.debug("Got vehicle %s", vehicle)
+                v = PorscheVehicle(
+                    vin=vehicle["vin"],
+                    data=vehicle,
+                    status={},
+                    connection=self.connection,
+                )
+                self.vehicles.append(v)
+
+            self.token = self.connection.token
+
+    async def get_vehicles(self, *, force_init: bool = False) -> list[PorscheVehicle]:
+        """Retrieve available vehicles from API endpoints."""
+        _LOGGER.debug("Retrieving vehicle list")
+
+        if len(self.vehicles) == 0 or force_init:
+            await self._init_vehicles()
+
+        return self.vehicles
+
+    async def get_vehicle(self, vin: str) -> PorscheVehicle | None:
+        """Retrieve vehicle data from API endpoints."""
+        if len(self.vehicles) == 0:
+            await self._init_vehicles()
+        filtered = [v for v in self.vehicles if v.vin == vin]
+        if len(filtered) > 0:
+            return filtered[0]
+        return None