umea-energi-api-client 0.1.0__tar.gz

umea_energi_api_client-0.1.0/LICENSE

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

umea_energi_api_client-0.1.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: umea-energi-api-client
+Version: 0.1.0
+Summary: Unofficial async Python client for the Umeå Energi API
+Author: Magnus Klingenberg
+Author-email: Magnus Klingenberg <klingenberg.magnus@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Dist: attrs>=26.1.0
+Requires-Dist: httpx>=0.28.1
+Requires-Python: >=3.14
+Project-URL: API Documentation, https://tapi.umeaenergi.se/
+Project-URL: Repository, https://github.com/klingenm/umea-energi-api-client
+Project-URL: Issues, https://github.com/klingenm/umea-energi-api-client/issues
+Description-Content-Type: text/markdown
+
+# umea-energi-api-client
+
+Unofficial, async-capable Python client for the Umeå Energi API, generated from its
+[OpenAPI document](https://tapi.umeaenergi.se/swagger/v2/swagger.json).
+See the [API documentation](https://tapi.umeaenergi.se/) for endpoint details.
+
+> **Disclaimer:** This is an independent project. The author has no affiliation with
+> Umeå Energi, which neither endorses nor supports this library. The library is in alpha:
+> its API may change between releases.
+
+## Usage
+
+```python
+from umea_energi_api_client import Client
+from umea_energi_api_client.generated.api.electricity import (
+    get_api_vversion_electricity_prices_net_area as get_prices,
+)
+
+async with Client(base_url="https://tapi.umeaenergi.se") as client:
+    prices = await get_prices.asyncio(version="2", net_area=2, client=client)
+```
+
+Every endpoint module also provides `sync`, `sync_detailed`, and `asyncio_detailed`.
+Use `AuthenticatedClient(base_url=..., token=...)` for endpoints that need a bearer token.
+
+## Development
+
+Tool versions (Python, uv, ruff, openapi-python-client) are pinned in `mise.toml`.
+
+```sh
+mise install         # install pinned tools
+mise run sync        # create .venv and install dependencies
+mise run generate    # generate the API client (gitignored; needed before imports work)
+mise run check       # lint, typecheck, test
+mise run fetch-spec  # update openapi/swagger.json from the API
+mise run change      # describe a change for the next release
+```
+
+### Releasing
+
+Changes are tracked with [knope](https://knope.tech) change files in `.changeset/`.
+`mise run release` bumps the version, updates the changelog, pushes, and creates a GitHub
+release, which publishes the package to PyPI.
+
+Run `mise tasks` to list all available tasks.
+
+## License
+
+[MIT](https://github.com/klingenm/umea-energi-api-client/blob/main/LICENSE). Provided "as is", without warranty of any kind.

umea_energi_api_client-0.1.0/README.md

@@ -0,0 +1,49 @@
+# umea-energi-api-client
+
+Unofficial, async-capable Python client for the Umeå Energi API, generated from its
+[OpenAPI document](https://tapi.umeaenergi.se/swagger/v2/swagger.json).
+See the [API documentation](https://tapi.umeaenergi.se/) for endpoint details.
+
+> **Disclaimer:** This is an independent project. The author has no affiliation with
+> Umeå Energi, which neither endorses nor supports this library. The library is in alpha:
+> its API may change between releases.
+
+## Usage
+
+```python
+from umea_energi_api_client import Client
+from umea_energi_api_client.generated.api.electricity import (
+    get_api_vversion_electricity_prices_net_area as get_prices,
+)
+
+async with Client(base_url="https://tapi.umeaenergi.se") as client:
+    prices = await get_prices.asyncio(version="2", net_area=2, client=client)
+```
+
+Every endpoint module also provides `sync`, `sync_detailed`, and `asyncio_detailed`.
+Use `AuthenticatedClient(base_url=..., token=...)` for endpoints that need a bearer token.
+
+## Development
+
+Tool versions (Python, uv, ruff, openapi-python-client) are pinned in `mise.toml`.
+
+```sh
+mise install         # install pinned tools
+mise run sync        # create .venv and install dependencies
+mise run generate    # generate the API client (gitignored; needed before imports work)
+mise run check       # lint, typecheck, test
+mise run fetch-spec  # update openapi/swagger.json from the API
+mise run change      # describe a change for the next release
+```
+
+### Releasing
+
+Changes are tracked with [knope](https://knope.tech) change files in `.changeset/`.
+`mise run release` bumps the version, updates the changelog, pushes, and creates a GitHub
+release, which publishes the package to PyPI.
+
+Run `mise tasks` to list all available tasks.
+
+## License
+
+[MIT](https://github.com/klingenm/umea-energi-api-client/blob/main/LICENSE). Provided "as is", without warranty of any kind.

umea_energi_api_client-0.1.0/pyproject.toml

@@ -0,0 +1,71 @@
+[project]
+name = "umea-energi-api-client"
+version = "0.1.0"
+description = "Unofficial async Python client for the Umeå Energi API"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+]
+dependencies = [
+    "attrs>=26.1.0",
+    "httpx>=0.28.1",
+]
+
+[[project.authors]]
+name = "Magnus Klingenberg"
+email = "klingenberg.magnus@gmail.com"
+
+[project.urls]
+"API Documentation" = "https://tapi.umeaenergi.se/"
+Repository = "https://github.com/klingenm/umea-energi-api-client"
+Issues = "https://github.com/klingenm/umea-energi-api-client/issues"
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = ["pytest>=9.1.1"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+exclude = ["src/umea_energi_api_client/generated/**"]
+select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "B",
+    "UP",
+    "SIM",
+    "RUF",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["umea_energi_api_client"]
+
+[tool.ty.src]
+include = [
+    "src",
+    "tests",
+    "scripts",
+]
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[tool.pytest]
+testpaths = ["tests"]
+addopts = ["--import-mode=importlib"]

umea_energi_api_client-0.1.0/pyproject.toml.orig

@@ -0,0 +1,61 @@
+[project]
+name = "umea-energi-api-client"
+version = "0.1.0"
+description = "Unofficial async Python client for the Umeå Energi API"
+readme = "README.md"
+authors = [
+    { name = "Magnus Klingenberg", email = "klingenberg.magnus@gmail.com" }
+]
+requires-python = ">=3.14"
+license = "MIT"
+license-files = ["LICENSE"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+]
+dependencies = [
+    "attrs>=26.1.0",
+    "httpx>=0.28.1",
+]
+
+[project.urls]
+"API Documentation" = "https://tapi.umeaenergi.se/"
+Repository = "https://github.com/klingenm/umea-energi-api-client"
+Issues = "https://github.com/klingenm/umea-energi-api-client/issues"
+
+[build-system]
+requires = ["uv_build>=0.13.5,<0.14.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.1.1",
+]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+# Generated by openapi-python-client (`mise run generate`); formatted but not linted.
+exclude = ["src/umea_energi_api_client/generated/**"]
+select = ["E", "W", "F", "I", "B", "UP", "SIM", "RUF"]
+
+[tool.ruff.lint.isort]
+# Keeps import order stable whether or not generated/ exists yet.
+known-first-party = ["umea_energi_api_client"]
+
+[tool.ty.src]
+include = ["src", "tests", "scripts"]
+
+[tool.ty.terminal]
+error-on-warning = true
+
+[tool.pytest]
+testpaths = ["tests"]
+addopts = ["--import-mode=importlib"]

umea_energi_api_client-0.1.0/src/umea_energi_api_client/__init__.py

@@ -0,0 +1,9 @@
+"""Python client for the Umeå Energi API."""
+
+from importlib.metadata import version
+
+from .generated import AuthenticatedClient, Client
+
+__all__ = ["AuthenticatedClient", "Client", "__version__"]
+
+__version__ = version("umea-energi-api-client")

umea_energi_api_client-0.1.0/src/umea_energi_api_client/generated/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Umeå Energi Public Web Api"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

umea_energi_api_client-0.1.0/src/umea_energi_api_client/generated/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

umea_energi_api_client-0.1.0/src/umea_energi_api_client/generated/api/account/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

umea_energi_api_client-0.1.0/src/umea_energi_api_client/generated/api/account/get_api_vversion_account_user_id_session.py

@@ -0,0 +1,191 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.umea_energi_api_models_login_user_session import UmeaEnergiApiModelsLoginUserSession
+from typing import cast
+
+
+def _get_kwargs(
+    version: str,
+    user_id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v{version}/Account/{user_id}/session".format(
+            version=quote(str(version), safe=""),
+            user_id=quote(str(user_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | UmeaEnergiApiModelsLoginUserSession | None:
+    if response.status_code == 200:
+        response_200 = UmeaEnergiApiModelsLoginUserSession.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | UmeaEnergiApiModelsLoginUserSession]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    version: str,
+    user_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Any | UmeaEnergiApiModelsLoginUserSession]:
+    """Get Refreshed User Session
+
+     Sample request:
+
+        GET /api/account/1/session/
+
+    Args:
+        version (str):
+        user_id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | UmeaEnergiApiModelsLoginUserSession]
+    """
+
+    kwargs = _get_kwargs(
+        version=version,
+        user_id=user_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    version: str,
+    user_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Any | UmeaEnergiApiModelsLoginUserSession | None:
+    """Get Refreshed User Session
+
+     Sample request:
+
+        GET /api/account/1/session/
+
+    Args:
+        version (str):
+        user_id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | UmeaEnergiApiModelsLoginUserSession
+    """
+
+    return sync_detailed(
+        version=version,
+        user_id=user_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    version: str,
+    user_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Any | UmeaEnergiApiModelsLoginUserSession]:
+    """Get Refreshed User Session
+
+     Sample request:
+
+        GET /api/account/1/session/
+
+    Args:
+        version (str):
+        user_id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any | UmeaEnergiApiModelsLoginUserSession]
+    """
+
+    kwargs = _get_kwargs(
+        version=version,
+        user_id=user_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    version: str,
+    user_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Any | UmeaEnergiApiModelsLoginUserSession | None:
+    """Get Refreshed User Session
+
+     Sample request:
+
+        GET /api/account/1/session/
+
+    Args:
+        version (str):
+        user_id (int):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Any | UmeaEnergiApiModelsLoginUserSession
+    """
+
+    return (
+        await asyncio_detailed(
+            version=version,
+            user_id=user_id,
+            client=client,
+        )
+    ).parsed