pybluecurrent 0.0.3__tar.gz → 0.1.0__tar.gz

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 fail_fast: true
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
         exclude: '\.(md|markdown)$'
@@ -27,7 +27,7 @@ repos:
       - id: isort
         exclude: __init__.py
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 6e63c9e
+    rev: v1.18.2
     hooks:
     -   id: mypy
         additional_dependencies:

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pybluecurrent
-Version: 0.0.3
+Version: 0.1.0
 Summary: Python client for BlueCurrent charge points.
 Author-email: Rogier van der Geer <rogier@vander-geer.nl>
 License: MIT
@@ -15,14 +15,15 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: asyncio-multisubscriber-queue>=0.4.1
-Requires-Dist: requests>=2.31.0
+Requires-Dist: httpx>=0.28
 Requires-Dist: sjcl>=0.2.1
-Requires-Dist: websockets>=11.0.3
+Requires-Dist: websockets>=14.0
 Provides-Extra: dev
 Requires-Dist: black==23.3.0; extra == "dev"
 Requires-Dist: pre-commit>=3.3.3; extra == "dev"
-Requires-Dist: pytest==8.1.2; extra == "dev"
-Requires-Dist: pytest-asyncio==0.21.1; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.2.0; extra == "dev"
+Dynamic: license-file
 
 # pybluecurrent
 
@@ -42,36 +43,32 @@ from pybluecurrent import BlueCurrentClient
 client = BlueCurrentClient("your_username", "your_secret_password")
 
 async with client:
-   charge_points = await client.get_charge_points()
-
-transactions = client.get_transactions(charge_points[0]["evse_id"])
+    charge_points = await client.get_charge_points()
+    transactions = await client.get_transactions(charge_points[0]["evse_id"])
 ```
 
 ## Methods
 
-BlueCurrent exposes two APIs, a synchronous REST API as well as an asynchronous Websocket API. 
-As a result, the `BlueCurrentClient` also exposes synchronous as well as asynchronous methods:
+The `BlueCurrentClient` exposes the following methods:
   
- - [Asynchronous](#asynchronous)
-   - [`get_account`](#getaccount---get-your-account-information)
-   - [`get_charge_cards`](#getchargecards---get-your-charge-cards)
-   - [`get_charge_points`](#getchargepoints---get-your-charge-points)
-   - [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
-   - [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
-   - [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
-   - [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
-   - [`set_status`](#setstatus---enable-or-disable-a-charge-point)
- - [Synchronous](#synchronous)
-   - [`login`](#login---log-in)
-   - [`get_charge_point_status`](#getchargepointstatus---get-the-status-of-a-charge-point)
-   - [`get_contracts`](#getcontracts---get-your-contracts)
-   - [`get_grids`](#getgrids---get-your-grid-connections)
-   - [`get_transactions`](#gettransactions---get-a-list-of-transactions)
-   - [`iterate_transactions`](#iteratetransactions---iterate-through-your-transactions)
-
-### Asynchronous
-
-The async methods can only be used when the websocket client is connected. For example:
+- [`get_account`](#getaccount---get-your-account-information)
+- [`get_charge_cards`](#getchargecards---get-your-charge-cards)
+- [`get_charge_points`](#getchargepoints---get-your-charge-points)
+- [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
+- [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
+- [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
+- [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
+- [`set_status`](#setstatus---enable-or-disable-a-charge-point)
+- [`login`](#login---log-in)
+- [`get_charge_point_status`](#getchargepointstatus---get-the-status-of-a-charge-point)
+- [`get_contracts`](#getcontracts---get-your-contracts)
+- [`get_grids`](#getgrids---get-your-grid-connections)
+- [`get_transactions`](#gettransactions---get-a-list-of-transactions)
+- [`iterate_transactions`](#iteratetransactions---iterate-through-your-transactions)
+
+### Connection
+
+The client can only be used when the websocket client is connected. For example:
 ```python
 client = BlueCurrentClient("your_username", "your_secret_password")
 async with client:
@@ -247,22 +244,10 @@ async def set_status(self, evse_id: str, enabled: bool) -> None
 - `evse_id`: The ID of the charge point.
 - `enabled`: Boolean that indicates the desired status.
 
-### Synchronous
-
-#### `login` - Log in
-```python
-def login(self) -> None
-```
-
-This method does not do anything if the client is already logged in. 
-Connection to the websocket api (async with client) automatically logs in the client,
-so this endpoint is not needed when using the async API.
-
-
 #### `get_charge_point_status` - Get the status of a charge point.
 
 ```python
-def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]
+async def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]
 ```
 
 ##### Arguments
@@ -295,7 +280,7 @@ A dictionary with the chargepoint status:
 #### `get_contracts` - Get your contracts.
 
 ```python
-def get_contracts(self) -> list[dict[str, str]]
+async def get_contracts(self) -> list[dict[str, str]]
 ```
 
 ##### Returns
@@ -315,7 +300,7 @@ A list of dictionaries, each representing a contract:
 #### `get_grids` - Get your grid connections.
 
 ```python
-def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]
+async def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]
 ```
 
 ##### Returns
@@ -334,7 +319,7 @@ A list of dictionaries, each representing a grid:
 #### `get_transactions` - Get a list of transactions.
 
 ```python
-def get_transactions(
+async def get_transactions(
         self, evse_id: str, newest_first: bool = True, page: int = 1
     ) -> dict[str, int | list[dict[str, Any]]]
 ```
@@ -376,7 +361,7 @@ A dictionary like this:
 #### `iterate_transactions` - Iterate through your transactions
 
 ```python
-def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> Iterable[dict[str, Any]]
+async def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> AsyncIterable[dict[str, Any]]
 ```
 
 ##### Arguments

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/README.md

@@ -16,36 +16,32 @@ from pybluecurrent import BlueCurrentClient
 client = BlueCurrentClient("your_username", "your_secret_password")
 
 async with client:
-   charge_points = await client.get_charge_points()
-
-transactions = client.get_transactions(charge_points[0]["evse_id"])
+    charge_points = await client.get_charge_points()
+    transactions = await client.get_transactions(charge_points[0]["evse_id"])
 ```
 
 ## Methods
 
-BlueCurrent exposes two APIs, a synchronous REST API as well as an asynchronous Websocket API. 
-As a result, the `BlueCurrentClient` also exposes synchronous as well as asynchronous methods:
+The `BlueCurrentClient` exposes the following methods:
   
- - [Asynchronous](#asynchronous)
-   - [`get_account`](#getaccount---get-your-account-information)
-   - [`get_charge_cards`](#getchargecards---get-your-charge-cards)
-   - [`get_charge_points`](#getchargepoints---get-your-charge-points)
-   - [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
-   - [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
-   - [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
-   - [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
-   - [`set_status`](#setstatus---enable-or-disable-a-charge-point)
- - [Synchronous](#synchronous)
-   - [`login`](#login---log-in)
-   - [`get_charge_point_status`](#getchargepointstatus---get-the-status-of-a-charge-point)
-   - [`get_contracts`](#getcontracts---get-your-contracts)
-   - [`get_grids`](#getgrids---get-your-grid-connections)
-   - [`get_transactions`](#gettransactions---get-a-list-of-transactions)
-   - [`iterate_transactions`](#iteratetransactions---iterate-through-your-transactions)
-
-### Asynchronous
-
-The async methods can only be used when the websocket client is connected. For example:
+- [`get_account`](#getaccount---get-your-account-information)
+- [`get_charge_cards`](#getchargecards---get-your-charge-cards)
+- [`get_charge_points`](#getchargepoints---get-your-charge-points)
+- [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
+- [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
+- [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
+- [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
+- [`set_status`](#setstatus---enable-or-disable-a-charge-point)
+- [`login`](#login---log-in)
+- [`get_charge_point_status`](#getchargepointstatus---get-the-status-of-a-charge-point)
+- [`get_contracts`](#getcontracts---get-your-contracts)
+- [`get_grids`](#getgrids---get-your-grid-connections)
+- [`get_transactions`](#gettransactions---get-a-list-of-transactions)
+- [`iterate_transactions`](#iteratetransactions---iterate-through-your-transactions)
+
+### Connection
+
+The client can only be used when the websocket client is connected. For example:
 ```python
 client = BlueCurrentClient("your_username", "your_secret_password")
 async with client:
@@ -221,22 +217,10 @@ async def set_status(self, evse_id: str, enabled: bool) -> None
 - `evse_id`: The ID of the charge point.
 - `enabled`: Boolean that indicates the desired status.
 
-### Synchronous
-
-#### `login` - Log in
-```python
-def login(self) -> None
-```
-
-This method does not do anything if the client is already logged in. 
-Connection to the websocket api (async with client) automatically logs in the client,
-so this endpoint is not needed when using the async API.
-
-
 #### `get_charge_point_status` - Get the status of a charge point.
 
 ```python
-def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]
+async def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]
 ```
 
 ##### Arguments
@@ -269,7 +253,7 @@ A dictionary with the chargepoint status:
 #### `get_contracts` - Get your contracts.
 
 ```python
-def get_contracts(self) -> list[dict[str, str]]
+async def get_contracts(self) -> list[dict[str, str]]
 ```
 
 ##### Returns
@@ -289,7 +273,7 @@ A list of dictionaries, each representing a contract:
 #### `get_grids` - Get your grid connections.
 
 ```python
-def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]
+async def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]
 ```
 
 ##### Returns
@@ -308,7 +292,7 @@ A list of dictionaries, each representing a grid:
 #### `get_transactions` - Get a list of transactions.
 
 ```python
-def get_transactions(
+async def get_transactions(
         self, evse_id: str, newest_first: bool = True, page: int = 1
     ) -> dict[str, int | list[dict[str, Any]]]
 ```
@@ -350,7 +334,7 @@ A dictionary like this:
 #### `iterate_transactions` - Iterate through your transactions
 
 ```python
-def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> Iterable[dict[str, Any]]
+async def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> AsyncIterable[dict[str, Any]]
 ```
 
 ##### Arguments

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/pyproject.toml

@@ -21,18 +21,18 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Typing :: Typed"
+    "Typing :: Typed",
 ]
 dependencies = [
     "asyncio-multisubscriber-queue>=0.4.1",
-    "requests>=2.31.0",
+    "httpx>=0.28",
     "sjcl>=0.2.1",
-    "websockets>=11.0.3",
+    "websockets>=14.0",
 ]
 dynamic = ["version"]
 
 [project.optional-dependencies]
-dev = ["black==23.3.0", "pre-commit>=3.3.3", "pytest==8.1.2", "pytest-asyncio==0.21.1"]
+dev = ["black==23.3.0", "pre-commit>=3.3.3", "pytest==8.4.2", "pytest-asyncio==1.2.0"]
 
 [project.urls]
 Repository = "https://github.com/rogiervandergeer/pybluecurrent"
@@ -53,3 +53,8 @@ profile = "black"
 [tool.ruff]
 line-length = 120
 target-version = "py310"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+asyncio_default_test_loop_scope = "session"

pybluecurrent-0.1.0/src/pybluecurrent/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.0'
+__version_tuple__ = version_tuple = (0, 1, 0)
+
+__commit_id__ = commit_id = 'g1fb6788fb'

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/src/pybluecurrent/client.py

@@ -1,14 +1,14 @@
-from asyncio import Task, create_task, run, wait_for
+from asyncio import Task, create_task, wait_for
 from datetime import date, datetime
 from json import dumps, loads
 from logging import getLogger
-from typing import Any, Iterable
+from typing import Any, AsyncIterable
 from uuid import uuid4
 
 from asyncio_multisubscriber_queue import MultisubscriberQueue
-from requests import get, post
+from httpx import AsyncClient
 from sjcl import SJCL
-from websockets import WebSocketClientProtocol, connect
+from websockets.asyncio.client import ClientConnection, connect
 
 from pybluecurrent._version import __version__
 from pybluecurrent.exceptions import AuthenticationFailed, BlueCurrentException
@@ -24,17 +24,18 @@ class BlueCurrentClient:
         self.consumer: Task | None = None
         self.credentials: tuple[str, str] = (username, password)
         self.logger = getLogger("BlueCurrentClient")
+        self.httpx_client: AsyncClient | None = None
         self.queue = MultisubscriberQueue()
-        self.socket: WebSocketClientProtocol | None = None
+        self.socket: ClientConnection | None = None
         self.token: str | None = None
 
-    ## Asynchronous API ##
-
     async def __aenter__(self) -> "BlueCurrentClient":
         self.logger.debug("Creating BlueCurrent websocket connection")
         self.connection = connect(self.socket_url, user_agent_header=self._user_agent)
         self.socket = await self.connection.__aenter__()
         self.consumer = create_task(self._handler())
+        self.httpx_client = AsyncClient()
+        await self.httpx_client.__aenter__()
         if self.token is None:
             await self._login()
         await self._hello()
@@ -44,7 +45,8 @@ class BlueCurrentClient:
         self.logger.debug("Closing BlueCurrent connection")
         self.consumer.cancel()
         await self.connection.__aexit__(exc_type, exc_val, exc_tb)
-        self.consumer, self.socket = None, None
+        await self.httpx_client.__aexit__(exc_type, exc_val, exc_tb)
+        self.consumer, self.socket, self.httpx_client = None, None, None
 
     async def get_account(self) -> dict[str, bool | date | str]:
         """
@@ -212,10 +214,17 @@ class BlueCurrentClient:
 
         Args:
             evse_id: A charge point ID.
-            uid: A charge card UID or None (for no charge card). Defaults to None.
+            uid: A charge card UID or None. Defaults to None.
+                Setting the plug-and-charge card to None will result in plug-and-charge
+                transactions being started without a charge card. Note that the
+                charge point status will show "BCU_HOME_USE" as the charge card.
+                Setting the plug-and-charge card to "BCU_HOME_USE" has the same effect
+                as setting it to None.
         """
+        token_uid = "BCU-APP" if uid is None or uid == "BCU_HOME_USE" else uid
         await self._send(
-            dict(command="SET_PLUG_AND_CHARGE_CHARGE_CARD", evse_id=evse_id, token_uid=uid or "BCU-APP"), token=True
+            dict(command="SET_PLUG_AND_CHARGE_CHARGE_CARD", evse_id=evse_id, token_uid=token_uid),
+            token=True,
         )
         result = await self._receive("STATUS_SET_PLUG_AND_CHARGE_CHARGE_CARD")
         if not result.get("success"):
@@ -256,25 +265,7 @@ class BlueCurrentClient:
         await self._receive("RECEIVED_SOFT_RESET")
         return await self._receive("STATUS_SOFT_RESET", timeout=30)
 
-    ## Synchronous API ##
-
-    def login(self) -> None:
-        """
-        Retrieves a connection token.
-
-        This method does not do anything if the client is already logged in.
-        Connection to the websocket api (async with client) automatically logs in the client,
-        so this endpoint is not needed when using the async API.
-        """
-
-        async def _login(client: BlueCurrentClient) -> None:
-            async with client:
-                pass
-
-        if self.token is None:
-            run(_login(self))
-
-    def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]:
+    async def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]:
         """
         Get the status of a charge point.
 
@@ -300,7 +291,9 @@ class BlueCurrentClient:
                 "evse_id": "BCU123456",
             }
         """
-        response = get(
+        if self.httpx_client is None:
+            raise RuntimeError(f"{self.__class__.__name__} is not connected.")
+        response = await self.httpx_client.get(
             f"{self.api_url}/chargepointstatus?evse_id={evse_id}",
             headers={"Authorization": f"Token {self.token}", "User-Agent": self._user_agent},
         )
@@ -314,7 +307,7 @@ class BlueCurrentClient:
             },
         )
 
-    def get_contracts(self) -> list[dict[str, str]]:
+    async def get_contracts(self) -> list[dict[str, str]]:
         """
         Get your contracts.
 
@@ -330,14 +323,16 @@ class BlueCurrentClient:
                 }
             ]
         """
-        response = get(
+        if self.httpx_client is None:
+            raise RuntimeError(f"{self.__class__.__name__} is not connected.")
+        response = await self.httpx_client.get(
             f"{self.api_url}/getcontracts",
             headers={"Authorization": f"Token {self.token}", "User-Agent": self._user_agent},
         )
         response.raise_for_status()
         return response.json()["contracts"]
 
-    def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]:
+    async def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]:
         """
         Get your grid connections.
 
@@ -352,14 +347,16 @@ class BlueCurrentClient:
                 }
             ]
         """
-        response = get(
+        if self.httpx_client is None:
+            raise RuntimeError(f"{self.__class__.__name__} is not connected.")
+        response = await self.httpx_client.get(
             f"{self.api_url}/getgrids",
             headers={"Authorization": f"Token {self.token}", "User-Agent": self._user_agent},
         )
         response.raise_for_status()
         return response.json()["grids"]
 
-    def get_transactions(
+    async def get_transactions(
         self, evse_id: str, newest_first: bool = True, page: int = 1
     ) -> dict[str, int | list[dict[str, Any]]]:
         """
@@ -398,13 +395,15 @@ class BlueCurrentClient:
             }
 
         """
-        response = post(
+        if self.httpx_client is None:
+            raise RuntimeError(f"{self.__class__.__name__} is not connected.")
+        response = await self.httpx_client.post(
             f"{self.api_url}/gettransactions?"
             f"page={page}&"
             f"sort_field_order={'DESC' if newest_first else 'ASC'}&"
             f"sort_field=stoppedtimestamp",
             headers={"Authorization": f"Token {self.token}", "User-Agent": self._user_agent},
-            data=dumps({"chargepoints": [{"chargepoint_id": evse_id}]}).encode("UTF-8"),
+            data=dumps({"chargepoints": [{"chargepoint_id": evse_id}]}),
         )
         response.raise_for_status()
         result = response.json()["data"]
@@ -414,7 +413,7 @@ class BlueCurrentClient:
         )
         return result
 
-    def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> Iterable[dict[str, Any]]:
+    async def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> AsyncIterable[dict[str, Any]]:
         """
         Iterate through your transactions.
 
@@ -443,8 +442,9 @@ class BlueCurrentClient:
         """
         next_page = 1
         while next_page is not None:
-            transactions = self.get_transactions(evse_id=evse_id, newest_first=newest_first, page=next_page)
-            yield from transactions["transactions"]  # type: ignore
+            transactions = await self.get_transactions(evse_id=evse_id, newest_first=newest_first, page=next_page)
+            for tx in transactions["transactions"]:  # type: ignore
+                yield tx
             next_page = transactions["next_page"]  # type: ignore
 
     async def _login(self) -> None:

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/src/pybluecurrent.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pybluecurrent
-Version: 0.0.3
+Version: 0.1.0
 Summary: Python client for BlueCurrent charge points.
 Author-email: Rogier van der Geer <rogier@vander-geer.nl>
 License: MIT
@@ -15,14 +15,15 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: asyncio-multisubscriber-queue>=0.4.1
-Requires-Dist: requests>=2.31.0
+Requires-Dist: httpx>=0.28
 Requires-Dist: sjcl>=0.2.1
-Requires-Dist: websockets>=11.0.3
+Requires-Dist: websockets>=14.0
 Provides-Extra: dev
 Requires-Dist: black==23.3.0; extra == "dev"
 Requires-Dist: pre-commit>=3.3.3; extra == "dev"
-Requires-Dist: pytest==8.1.2; extra == "dev"
-Requires-Dist: pytest-asyncio==0.21.1; extra == "dev"
+Requires-Dist: pytest==8.4.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.2.0; extra == "dev"
+Dynamic: license-file
 
 # pybluecurrent
 
@@ -42,36 +43,32 @@ from pybluecurrent import BlueCurrentClient
 client = BlueCurrentClient("your_username", "your_secret_password")
 
 async with client:
-   charge_points = await client.get_charge_points()
-
-transactions = client.get_transactions(charge_points[0]["evse_id"])
+    charge_points = await client.get_charge_points()
+    transactions = await client.get_transactions(charge_points[0]["evse_id"])
 ```
 
 ## Methods
 
-BlueCurrent exposes two APIs, a synchronous REST API as well as an asynchronous Websocket API. 
-As a result, the `BlueCurrentClient` also exposes synchronous as well as asynchronous methods:
+The `BlueCurrentClient` exposes the following methods:
   
- - [Asynchronous](#asynchronous)
-   - [`get_account`](#getaccount---get-your-account-information)
-   - [`get_charge_cards`](#getchargecards---get-your-charge-cards)
-   - [`get_charge_points`](#getchargepoints---get-your-charge-points)
-   - [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
-   - [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
-   - [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
-   - [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
-   - [`set_status`](#setstatus---enable-or-disable-a-charge-point)
- - [Synchronous](#synchronous)
-   - [`login`](#login---log-in)
-   - [`get_charge_point_status`](#getchargepointstatus---get-the-status-of-a-charge-point)
-   - [`get_contracts`](#getcontracts---get-your-contracts)
-   - [`get_grids`](#getgrids---get-your-grid-connections)
-   - [`get_transactions`](#gettransactions---get-a-list-of-transactions)
-   - [`iterate_transactions`](#iteratetransactions---iterate-through-your-transactions)
-
-### Asynchronous
-
-The async methods can only be used when the websocket client is connected. For example:
+- [`get_account`](#getaccount---get-your-account-information)
+- [`get_charge_cards`](#getchargecards---get-your-charge-cards)
+- [`get_charge_points`](#getchargepoints---get-your-charge-points)
+- [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
+- [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
+- [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
+- [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
+- [`set_status`](#setstatus---enable-or-disable-a-charge-point)
+- [`login`](#login---log-in)
+- [`get_charge_point_status`](#getchargepointstatus---get-the-status-of-a-charge-point)
+- [`get_contracts`](#getcontracts---get-your-contracts)
+- [`get_grids`](#getgrids---get-your-grid-connections)
+- [`get_transactions`](#gettransactions---get-a-list-of-transactions)
+- [`iterate_transactions`](#iteratetransactions---iterate-through-your-transactions)
+
+### Connection
+
+The client can only be used when the websocket client is connected. For example:
 ```python
 client = BlueCurrentClient("your_username", "your_secret_password")
 async with client:
@@ -247,22 +244,10 @@ async def set_status(self, evse_id: str, enabled: bool) -> None
 - `evse_id`: The ID of the charge point.
 - `enabled`: Boolean that indicates the desired status.
 
-### Synchronous
-
-#### `login` - Log in
-```python
-def login(self) -> None
-```
-
-This method does not do anything if the client is already logged in. 
-Connection to the websocket api (async with client) automatically logs in the client,
-so this endpoint is not needed when using the async API.
-
-
 #### `get_charge_point_status` - Get the status of a charge point.
 
 ```python
-def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]
+async def get_charge_point_status(self, evse_id: str) -> dict[str, datetime | float | int | str | None]
 ```
 
 ##### Arguments
@@ -295,7 +280,7 @@ A dictionary with the chargepoint status:
 #### `get_contracts` - Get your contracts.
 
 ```python
-def get_contracts(self) -> list[dict[str, str]]
+async def get_contracts(self) -> list[dict[str, str]]
 ```
 
 ##### Returns
@@ -315,7 +300,7 @@ A list of dictionaries, each representing a contract:
 #### `get_grids` - Get your grid connections.
 
 ```python
-def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]
+async def get_grids(self) -> list[dict[str, bool | dict[str, str] | str]]
 ```
 
 ##### Returns
@@ -334,7 +319,7 @@ A list of dictionaries, each representing a grid:
 #### `get_transactions` - Get a list of transactions.
 
 ```python
-def get_transactions(
+async def get_transactions(
         self, evse_id: str, newest_first: bool = True, page: int = 1
     ) -> dict[str, int | list[dict[str, Any]]]
 ```
@@ -376,7 +361,7 @@ A dictionary like this:
 #### `iterate_transactions` - Iterate through your transactions
 
 ```python
-def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> Iterable[dict[str, Any]]
+async def iterate_transactions(self, evse_id: str, newest_first: bool = True) -> AsyncIterable[dict[str, Any]]
 ```
 
 ##### Arguments

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/src/pybluecurrent.egg-info/requires.txt

@@ -1,10 +1,10 @@
 asyncio-multisubscriber-queue>=0.4.1
-requests>=2.31.0
+httpx>=0.28
 sjcl>=0.2.1
-websockets>=11.0.3
+websockets>=14.0
 
 [dev]
 black==23.3.0
 pre-commit>=3.3.3
-pytest==8.1.2
-pytest-asyncio==0.21.1
+pytest==8.4.2
+pytest-asyncio==1.2.0

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/tests/conftest.py

@@ -1,9 +1,7 @@
-from asyncio import get_event_loop_policy, run
 from os import environ
 from typing import AsyncGenerator
 
 from pytest import fixture, skip
-from pytest_asyncio import fixture as async_fixture
 
 from pybluecurrent import BlueCurrentClient
 
@@ -22,14 +20,6 @@ def client_with_auth() -> BlueCurrentClient | None:
 
 
 @fixture(scope="session")
-def event_loop():
-    policy = get_event_loop_policy()
-    loop = policy.new_event_loop()
-    yield loop
-    loop.close()
-
-
-@async_fixture(scope="session")
 async def connected_client() -> AsyncGenerator[BlueCurrentClient, None]:
     try:
         client = BlueCurrentClient(environ["BLUECURRENT_USERNAME"], environ["BLUECURRENT_PASSWORD"])
@@ -41,13 +31,8 @@ async def connected_client() -> AsyncGenerator[BlueCurrentClient, None]:
 
 
 @fixture(scope="session")
-def evse_id(client_with_auth: BlueCurrentClient) -> str:
-    async def _get_charge_points(client: BlueCurrentClient) -> list:
-        async with client:
-            charge_points = await client.get_charge_points()
-        return charge_points
-
-    result: list = run(_get_charge_points(client_with_auth))
-    if len(result) == 0:
+async def evse_id(connected_client: BlueCurrentClient) -> str:
+    charge_points = await connected_client.get_charge_points()
+    if not charge_points:
         skip("No charge points available.")
-    return result[0]["evse_id"]
+    return charge_points[0]["evse_id"]  # type: ignore

{pybluecurrent-0.0.3 → pybluecurrent-0.1.0}/tests/test_client.py

@@ -1,8 +1,7 @@
 from datetime import date
-from itertools import islice
 from os import environ
 
-from pytest import fixture, mark, raises, skip
+from pytest import mark, raises, skip
 
 from pybluecurrent import BlueCurrentClient
 from pybluecurrent.exceptions import AuthenticationFailed, BlueCurrentException
@@ -17,30 +16,22 @@ class TestHeaders:
 
 
 class TestAuthentication:
-    @mark.asyncio
     async def test_authenticate(self, client_with_auth: BlueCurrentClient):
         async with client_with_auth:
             assert client_with_auth.token is not None
 
-    @mark.asyncio
     async def test_authentication_failed(self, client: BlueCurrentClient):
         with raises(AuthenticationFailed):
             async with client:
                 pass
 
-    def test_login(self, client_with_auth: BlueCurrentClient):
-        client_with_auth.login()
-        assert client_with_auth.token is not None
-
 
 class TestSocketApi:
-    @mark.asyncio
     async def test_get_account(self, connected_client: BlueCurrentClient):
         account = await connected_client.get_account()
         assert "full_name" in account
         assert isinstance(account["first_login_app"], date)
 
-    @mark.asyncio
     async def test_get_charge_cards(self, connected_client: BlueCurrentClient):
         charge_cards = await connected_client.get_charge_cards()
         if len(charge_cards) == 0:
@@ -56,7 +47,6 @@ class TestSocketApi:
             ]
         )
 
-    @mark.asyncio
     async def test_get_charge_points(self, connected_client: BlueCurrentClient):
         charge_points = await connected_client.get_charge_points()
         if len(charge_points) == 0:
@@ -64,41 +54,34 @@ class TestSocketApi:
         for charge_point in charge_points:
             assert "evse_id" in charge_point
 
-    @mark.asyncio
     async def test_get_grid_status(self, connected_client: BlueCurrentClient, evse_id: str):
         status = await connected_client.get_grid_status(evse_id=evse_id)
         assert "grid_actual_p1" in status
         assert "id" in status
 
-    @mark.asyncio
     async def test_get_charge_point_settings(self, connected_client: BlueCurrentClient, evse_id: str):
         settings = await connected_client.get_charge_point_settings(evse_id=evse_id)
         assert isinstance(settings, dict)
         assert settings["evse_id"] == evse_id
 
-    @mark.asyncio
     @mark.skip("Does not work")
     async def test_get_sessions(self, connected_client: BlueCurrentClient, evse_id: str):
         sessions = await connected_client.get_sessions(evse_id=evse_id)
         print(sessions)
 
-    @mark.asyncio
     async def test_get_sustainability_status(self, connected_client: BlueCurrentClient):
         sessions = await connected_client.get_sustainability_status()
         assert set(sessions.keys()) == {"trees", "co2"}
 
-    @mark.asyncio
     @mark.skip("Does not work.")
     async def test_unlock_connector(self, connected_client: BlueCurrentClient, evse_id: str):
         result = await connected_client.unlock_connector(evse_id=evse_id)
         print(result)
 
-    @mark.asyncio
     @mark.skip("Do not change chargepoint status.")
     async def test_soft_reset(self, connected_client: BlueCurrentClient, evse_id: str):
         _ = await connected_client.soft_reset(evse_id=evse_id)
 
-    @mark.asyncio
     @mark.skipif(environ.get("BLUECURRENT_READ_ONLY", "TRUE") != "FALSE", reason="Running read-only tests.")
     async def test_set_plug_and_charge_card(self, connected_client: BlueCurrentClient, evse_id: str):
         async def _get_plug_and_charge_card_uid() -> str | None:
@@ -115,7 +98,7 @@ class TestSocketApi:
         charge_cards = await connected_client.get_charge_cards()
         if len(charge_cards) == 0:
             skip(reason="No charge cards.")
-        uids: list[str | None] = [charge_card["uid"] for charge_card in charge_cards] + [None]  # type: ignore
+        uids: list[str | None] = [charge_card["uid"] for charge_card in charge_cards] + ["BCU_HOME_USE"]  # type: ignore
         # Set each card as plug_and_charge_card
         for uid in uids:
             if uid != before_card:
@@ -125,7 +108,6 @@ class TestSocketApi:
         await connected_client.set_plug_and_charge_charge_card(evse_id=evse_id, uid=before_card)
         assert await _get_plug_and_charge_card_uid() == before_card
 
-    @mark.asyncio
     @mark.skipif(environ.get("BLUECURRENT_READ_ONLY", "TRUE") != "FALSE", reason="Running read-only tests.")
     async def test_set_invalid_plug_and_charge_card(self, connected_client: BlueCurrentClient, evse_id: str):
         settings = await connected_client.get_charge_point_settings(evse_id=evse_id)
@@ -133,18 +115,16 @@ class TestSocketApi:
             await connected_client.set_plug_and_charge_charge_card(evse_id=evse_id, uid="INVALID_CARD")
         assert await connected_client.get_charge_point_settings(evse_id=evse_id) == settings
 
-    @mark.asyncio
     @mark.skipif(environ.get("BLUECURRENT_READ_ONLY", "TRUE") != "FALSE", reason="Running read-only tests.")
     async def test_set_status(self, connected_client: BlueCurrentClient, evse_id: str):
-        before_status = connected_client.get_charge_point_status(evse_id=evse_id)
+        before_status = await connected_client.get_charge_point_status(evse_id=evse_id)
         if before_status["activity"] != "available":
             skip(reason="Only perform this test if the charge point is available.")
         await connected_client.set_status(evse_id=evse_id, enabled=False)
-        assert connected_client.get_charge_point_status(evse_id=evse_id)["activity"] == "unavailable"
+        assert (await connected_client.get_charge_point_status(evse_id=evse_id))["activity"] == "unavailable"
         await connected_client.set_status(evse_id=evse_id, enabled=True)
-        assert connected_client.get_charge_point_status(evse_id=evse_id)["activity"] == "available"
+        assert (await connected_client.get_charge_point_status(evse_id=evse_id))["activity"] == "available"
 
-    @mark.asyncio
     async def test_error(self, connected_client: BlueCurrentClient):
         with raises(BlueCurrentException) as e:
             await connected_client.set_status("BCU123456", False)
@@ -152,33 +132,36 @@ class TestSocketApi:
 
 
 class TestRestApi:
-    @fixture(scope="class")
-    def authenticated_client(self, client_with_auth: BlueCurrentClient) -> BlueCurrentClient:
-        client_with_auth.login()
-        return client_with_auth
-
-    def test_get_contracts(self, authenticated_client: BlueCurrentClient):
-        contracts = authenticated_client.get_contracts()
+    async def test_get_contracts(self, connected_client: BlueCurrentClient):
+        contracts = await connected_client.get_contracts()
         assert len(contracts) > 0
         assert "contract_id" in contracts[0]
 
-    def test_get_charge_point_status(self, authenticated_client: BlueCurrentClient, evse_id: str):
-        status = authenticated_client.get_charge_point_status(evse_id)
+    async def test_get_charge_point_status(self, connected_client: BlueCurrentClient, evse_id: str):
+        status = await connected_client.get_charge_point_status(evse_id)
         assert status["evse_id"] == evse_id
         assert "activity" in status
 
-    def test_get_grids(self, authenticated_client: BlueCurrentClient):
-        grids = authenticated_client.get_grids()
+    async def test_get_grids(self, connected_client: BlueCurrentClient):
+        grids = await connected_client.get_grids()
         assert len(grids) > 0
         assert "id" in grids[0]
 
-    def test_get_transactions(self, authenticated_client: BlueCurrentClient, evse_id: str):
-        transactions = authenticated_client.get_transactions(evse_id)
+    async def test_get_transactions(self, connected_client: BlueCurrentClient, evse_id: str):
+        transactions = await connected_client.get_transactions(evse_id)
         assert "transactions" in transactions
 
-    def test_iterate_transactions(self, authenticated_client: BlueCurrentClient, evse_id: str):
-        transactions = authenticated_client.get_transactions(evse_id)
-        # If there are less than three pages, there might be less than 30.
+    async def test_iterate_transactions(self, connected_client: BlueCurrentClient, evse_id: str):
+        transactions = await connected_client.get_transactions(evse_id)
+        # If there are less than three pages, there might be fewer than 30.
         if transactions["total_pages"] < 3:  # type: ignore
             skip("Not enough transactions.")
-        assert len({t["transaction_id"] for t in islice(authenticated_client.iterate_transactions(evse_id), 30)}) == 30
+        n_transactions = 0
+        # Verify pagination works correctly - we get 30 unique transactions from multiple pages.
+        unique_transactions = set()
+        async for transaction in connected_client.iterate_transactions(evse_id):
+            n_transactions += 1
+            unique_transactions.add(transaction["transaction_id"])
+            if n_transactions >= 30:
+                break
+        assert len(unique_transactions) == 30

pybluecurrent-0.0.3/src/pybluecurrent/_version.py

@@ -1,16 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '0.0.3'
-__version_tuple__ = version_tuple = (0, 0, 3)