flowion 0.2.0__tar.gz

flowion-0.2.0/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

flowion-0.2.0/LICENSE-MIT

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

flowion-0.2.0/PKG-INFO

@@ -0,0 +1,293 @@
+Metadata-Version: 2.5
+Name: flowion
+Version: 0.2.0
+Summary: The Flowion API client for Python
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-Expression: MIT OR Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Requires-Dist: aiohttp>=3.9 ; extra == "aiohttp"
+Project-URL: Homepage, https://flowion.io
+Provides-Extra: aiohttp
+Import-Name: flowion
+
+# flowion
+
+The Python client for the Flowion API.
+
+> **Beta.** The API schema is not yet committed to and may change in any
+> `0.MINOR` release. Pin an exact version (`flowion==0.1.0`) and read the release
+> notes before you move.
+
+Async-first, typed (`py.typed`, checked with `mypy --strict`), and it needs no
+HTTP library of its own: you hand it a transport. Most of the package is
+generated from the API's OpenAPI contract. Supported Python: **3.12 and newer**
+(verified on 3.12 and 3.14). Licensed `MIT OR Apache-2.0`.
+
+## Install
+
+```shell
+pip install flowion               # the SDK alone: standard library only
+pip install "flowion[aiohttp]"    # plus the adapter for an aiohttp session
+```
+
+## The transport
+
+The SDK never opens a connection. Everything goes through one small protocol
+(`flowion.Transport`), so the HTTP stack, its pool and its TLS settings stay
+yours:
+
+```python
+class Transport(Protocol):
+    async def send(self, request: Request) -> Response: ...
+    def stream(self, request: Request) -> AbstractAsyncContextManager[StreamResponse]: ...
+```
+
+`send` returns for every HTTP status (4xx and 5xx included) and raises only
+`TransportError` when no response arrived. It does not follow redirects, header
+names in `Response.headers` are lowercase, and `asyncio.CancelledError` must
+pass through untouched. `Request` carries `method`, `url`, `headers`, `body`
+and `timeout`; `Response` is `status`, `headers`, `body`; `StreamResponse` is
+`status`, `headers` and an async iterator of byte chunks.
+
+A custom transport is a dozen lines. This is an illustration over `httpx`, not
+something the SDK ships or tests:
+
+```python
+class HttpxTransport:
+    def __init__(self, http: httpx.AsyncClient) -> None:
+        self._http = http
+
+    async def send(self, request: Request) -> Response:
+        try:
+            r = await self._http.request(request.method, request.url, headers=dict(request.headers), content=request.body, timeout=request.timeout)
+        except httpx.HTTPError as error:
+            raise TransportError(str(error)) from error
+        return Response(r.status_code, {k.lower(): v for k, v in r.headers.items()}, r.content)
+
+    # stream(): an @asynccontextmanager that yields a StreamResponse built the same way.
+```
+
+For aiohttp there is an adapter, and it works over a session you already own.
+Home Assistant passes its own; the adapter only calls `session.request(...)`
+with that one request's headers and timeout. It never closes the session,
+never changes its headers or cookie jar, and never touches its connector:
+
+```python
+from flowion.aiohttp_transport import AiohttpTransport
+
+session = async_get_clientsession(hass)   # Home Assistant's shared session
+transport = AiohttpTransport(session)
+```
+
+The Flowion gateway is bearer-only and sets no cookies, which is what makes
+sharing a session safe. The adapter cannot stop aiohttp sending a cookie the
+session already holds for that host.
+
+## First call
+
+Every operation is an `async` method on a resource group:
+`client.<group>.<method>(...)`. Path parameters come first, in path order;
+everything else is a keyword. `token` is an API key or access token as a string:
+
+<!-- test -->
+```python
+from flowion import Client
+
+client = Client(transport, token="flw_ak_your_key_here")
+project_id = "11111111-1111-4111-8111-111111111111"
+
+page = await client.projects.charging_stations.list_chargers(project_id, limit=25)
+for charger in page.data:
+    print(charger.charge_point_id, charger.status)
+```
+
+(`transport` is any `Transport`, for example `AiohttpTransport(session)`.)
+Python keywords and builtins get a trailing underscore in field names: the id
+of a charger is `charger.id_`. `Client(..., mode="sandbox")` sends
+`X-Flowion-Mode`; `timeout_seconds=` sets the per-request timeout (30 s by
+default).
+
+A token that expires should not be a string. Pass a `TokenProvider`, an async
+callable awaited **once per request**, so your own refresh logic runs under
+your own lock:
+
+<!-- test -->
+```python
+async def current_token() -> str:
+    return "the-current-access-token"   # read it from your token store, refreshing if needed
+
+client = Client(transport, token=current_token)
+page = await client.projects.charging_stations.list_chargers(project_id)
+```
+
+A `401` with code `invalidToken` raises `ApiError`. The client does not refresh
+and does not retry it; that is the caller's decision.
+
+## The grant for a public client
+
+`flowion.oauth.OAuthClient` implements the authorization-code grant with PKCE
+for a **public client**: no client secret, ever. Three steps, and the SDK
+stores nothing between them: you keep `state` and `code_verifier` yourself.
+
+For Home Assistant, the redirect URI is `https://my.home-assistant.io/redirect/oauth`
+and the scopes are `chargers:read prices:read sessions:read`. The `client_id` is
+the one registered for your integration with Flowion.
+
+<!-- test -->
+```python
+from flowion.oauth import OAuthClient
+
+oauth = OAuthClient(
+    transport,
+    client_id="your-client-id",
+    redirect_uri="https://my.home-assistant.io/redirect/oauth",
+)
+request = oauth.authorization_request(scopes=["chargers:read", "prices:read", "sessions:read"])
+print(request.url)   # send the user's browser here; keep request.state and request.code_verifier
+```
+
+The user approves on Flowion and the browser comes back to the redirect URI.
+`parse_redirect` accepts the full URL or just its query, checks `state` in
+constant time and sends nothing. Then exchange the code, call the API, and
+refresh before the access token expires:
+
+<!-- test -->
+```python
+from flowion import Client
+
+# redirect_url: the full URL the user's browser came back to
+result = oauth.parse_redirect(redirect_url, expected_state=request.state)
+tokens = await oauth.exchange_code(result.code, code_verifier=request.code_verifier)
+
+client = Client(transport, token=tokens.access_token)
+async for project in client.connection.connection_projects_all():
+    print(project.id_, project.name)
+
+# tokens.expires_at is an aware datetime; refresh ahead of it.
+tokens = await oauth.refresh(tokens.refresh_token)   # the old refresh token is now spent
+```
+
+Things to know:
+
+- **Refresh is rotating.** Keep the new `refresh_token` from every refresh.
+  Replaying a spent one ends the whole grant (`InvalidGrant`: authorize again).
+  Two concurrent `refresh` calls on one token race into exactly that, so
+  serialise refresh behind one lock, as Home Assistant's `OAuth2Session` does.
+- **Errors map to types:** `AccessDenied` (the user declined), `StateMismatch`,
+  `InvalidGrant`, `InvalidClient`, `InvalidRequest`, all subclasses of
+  `OAuthError` with the RFC 6749 `code`.
+- **The Home Assistant data routes** are three read-only calls under
+  `/v1/connection/projects/{projectId}/`: `chargers`, `price` and `sessions`. They
+  land with the platform release that adds them (spec 166) and are **not in this
+  SDK release**, so it has no method for them yet; they appear in the first SDK
+  regenerated after that release ships. Until then the grant above works, and
+  `client.connection` offers the calls the contract has today.
+
+## Errors
+
+Everything the SDK raises on purpose derives from `flowion.FlowionError`:
+
+- `TransportError`: no response arrived (connect, read, TLS, timeout). Never retried.
+- `RateLimitedError`: a `429` that was not, or no longer could be, retried.
+  `retry_after_seconds` and `rate_limit` (`limit`, `remaining`, `reset_seconds`).
+- `ApiError`: any other non-2xx answer with the platform's error body. `status`,
+  `code` (the platform's string, verbatim), `body` and `request_id`.
+- `DecodeError`: a body the SDK cannot decode (a proxy's HTML page, truncated
+  JSON); carries `status`, `request_id` and a short `excerpt`.
+- `OAuthError` and its subclasses, above.
+
+```python
+try:
+    await client.projects.charging_stations.list_chargers(project_id)
+except RateLimitedError as error:
+    print("slow down for", error.retry_after_seconds, "s")
+except ApiError as error:
+    print(error.status, error.code, "request id", error.request_id)   # quote it when you report a problem
+```
+
+**Retry is on by default and covers `429` only**: up to 4 attempts in total,
+waiting the platform's `Retry-After` (1 s if it sent none). A `Retry-After`
+above the 30 s cap is not waited for: the error surfaces at once so you decide.
+A `5xx` or a transport error is never retried, because a write may already have
+been processed. Tune it with `RetryPolicy(max_attempts=..., max_wait_seconds=...)`;
+`max_attempts=1` turns it off. `client.last_rate_limit` holds the rate-limit
+headers of the latest response.
+
+## Values the SDK has not seen
+
+The API can grow a new enum value or a new variant of a union without the SDK
+changing. Such a response is **kept, not rejected**: an open enum is typed
+`Literal[...] | str`, and an open union gains an `...Unrecognized` form holding
+the raw data. For each there is a guard that narrows to the known values:
+
+<!-- test -->
+```python
+from flowion.generated.types import is_charger_status_known
+
+for charger in page.data:
+    if is_charger_status_known(charger.status):
+        ...   # the type checker now knows it is "online" or "offline"
+    else:
+        ...   # a status added after this release; charger.status is the raw string
+```
+
+## Pagination and live events
+
+Each list operation has an `*_all` twin that returns an async iterator over
+every item, fetching the next page only when you read past the last one:
+
+```python
+async for charger in client.projects.charging_stations.list_chargers_all(project_id, status="online"):
+    print(charger.charge_point_id)
+```
+
+A live-event stream is an async iterator too. It ends on a clean close or when
+the server revokes the stream, and an event type the SDK does not know is
+yielded as the unrecognized form instead of raising into your loop:
+
+```python
+async for event in client.projects.live_events.stream_live_events(project_id):
+    print(event.charging_station_id, event.type_)
+```
+
+## What is not provided
+
+- The confidential-client path (HTTP Basic client secret). This SDK is for
+  public clients.
+- The browser consent routes (`/v1/connections/authorize/*`), which take a
+  signed-in session, not a bearer token. The SDK builds the authorization URL;
+  the user opens it.
+- Token storage, caching or persistence, and opening a browser. You keep the
+  `state`, the verifier and the tokens.
+- A synchronous facade. Run the client on an event loop.
+- A default HTTP stack. Bring a `Transport`, or install the aiohttp extra.
+
+## Security
+
+Tokens, API keys, authorization codes and PKCE verifiers are never put in
+logs or in configuration in clear, and the SDK never logs them: not in
+messages, not in `repr`, not in exceptions. The `flowion` logger emits DEBUG
+lines with method, path, status and request id only. Keep your own tokens out
+of your logs and store them in your platform's secret storage.
+
+## What has been verified
+
+The package is exercised against a mock transport, against the shared
+shared conformance scenarios that every Flowion SDK plays, and,
+for the grant, against a local server that plays the platform's side. Runs
+against production are checked by the maintainers for each release, not by the
+test suite.
+
+## Licence
+
+`MIT OR Apache-2.0`, at your option. See `LICENSE-MIT` and `LICENSE-APACHE`.
+