enapter 0.25.0__tar.gz

enapter-0.25.0/LICENSE

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

enapter-0.25.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: enapter
+Version: 0.25.0
+Summary: Enapter Python SDK
+Author-email: Roman Novatorov <rnovatorov@enapter.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Enapter/python-sdk
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiomqtt==2.*
+Requires-Dist: dnspython==2.*
+Requires-Dist: json-log-formatter==1.*
+Requires-Dist: httpx==0.28.*
+Dynamic: license-file
+
+# Enapter Python SDK
+
+[![CI](https://github.com/Enapter/python-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/Enapter/python-sdk/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/enapter.svg)](https://pypi.org/project/enapter)
+[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
+
+A software development kit (SDK) for building applications and integrations
+with Enapter using Python.
+
+## Features
+
+- [Standalone
+  Devices](https://v3.developers.enapter.com/docs/standalone/introduction)
+  framework
+- [MQTT
+  API](https://v3.developers.enapter.com/reference/device_integration/mqtt_api/)
+  client
+- [HTTP API](https://v3.developers.enapter.com/reference/http/intro) client
+
+## Installation
+
+> [!IMPORTANT]
+> Requires **Python 3.11+**.
+
+> [!WARNING]
+> The API is still under development and may change at any time. It is
+> recommended to pin the package version when installing.
+
+Install from PyPI:
+
+```bash
+pip install enapter==0.25.0
+```
+
+## Usage
+
+Explore the examples:
+
+- [Standalone Devices](examples/standalone)
+- [MQTT API](examples/mqtt/api)
+- [HTTP API](examples/http/api)
+
+These provide a good overview of the available features and should give you
+enough to get started.
+
+> [!TIP]
+> Don't hesitate to peek into the source code - it's meant to be easy to
+> follow.
+
+## Help
+
+If you feel lost or confused, reach us on
+[Discord](https://discord.com/invite/TCaEZs3qpe) or just [file a
+bug](https://github.com/Enapter/python-sdk/issues/new). We'd be glad to help.

enapter-0.25.0/README.md

@@ -0,0 +1,54 @@
+# Enapter Python SDK
+
+[![CI](https://github.com/Enapter/python-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/Enapter/python-sdk/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/enapter.svg)](https://pypi.org/project/enapter)
+[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
+
+A software development kit (SDK) for building applications and integrations
+with Enapter using Python.
+
+## Features
+
+- [Standalone
+  Devices](https://v3.developers.enapter.com/docs/standalone/introduction)
+  framework
+- [MQTT
+  API](https://v3.developers.enapter.com/reference/device_integration/mqtt_api/)
+  client
+- [HTTP API](https://v3.developers.enapter.com/reference/http/intro) client
+
+## Installation
+
+> [!IMPORTANT]
+> Requires **Python 3.11+**.
+
+> [!WARNING]
+> The API is still under development and may change at any time. It is
+> recommended to pin the package version when installing.
+
+Install from PyPI:
+
+```bash
+pip install enapter==0.25.0
+```
+
+## Usage
+
+Explore the examples:
+
+- [Standalone Devices](examples/standalone)
+- [MQTT API](examples/mqtt/api)
+- [HTTP API](examples/http/api)
+
+These provide a good overview of the available features and should give you
+enough to get started.
+
+> [!TIP]
+> Don't hesitate to peek into the source code - it's meant to be easy to
+> follow.
+
+## Help
+
+If you feel lost or confused, reach us on
+[Discord](https://discord.com/invite/TCaEZs3qpe) or just [file a
+bug](https://github.com/Enapter/python-sdk/issues/new). We'd be glad to help.

enapter-0.25.0/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = "enapter"
+description = "Enapter Python SDK"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+authors = [
+    { name = "Roman Novatorov", email = "rnovatorov@enapter.com" },
+]
+dependencies = [
+    "aiomqtt==2.*",
+    "dnspython==2.*",
+    "json-log-formatter==1.*",
+    "httpx==0.28.*",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/Enapter/python-sdk"
+
+[dependency-groups]
+dev = [
+    "black",
+    "docker",
+    "isort",
+    "mypy",
+    "pyflakes",
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "types-docker",
+]
+
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = { attr = "enapter.__version__" }
+
+[tool.isort]
+profile = "black"
+known_first_party = ["enapter"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

enapter-0.25.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

enapter-0.25.0/src/enapter/__init__.py

@@ -0,0 +1,13 @@
+__version__ = "0.25.0"
+
+from . import async_, log, mdns, mqtt, http, standalone  # isort: skip
+
+__all__ = [
+    "__version__",
+    "async_",
+    "log",
+    "mdns",
+    "mqtt",
+    "http",
+    "standalone",
+]

enapter-0.25.0/src/enapter/__main__.py

@@ -0,0 +1,9 @@
+import asyncio
+
+from enapter import cli
+
+app = cli.App.new()
+try:
+    asyncio.run(app.run())
+except KeyboardInterrupt:
+    pass

enapter-0.25.0/src/enapter/async_/__init__.py

@@ -0,0 +1,4 @@
+from .generator import generator
+from .routine import Routine
+
+__all__ = ["generator", "Routine"]

enapter-0.25.0/src/enapter/async_/generator.py

@@ -0,0 +1,18 @@
+import contextlib
+import functools
+from typing import AsyncContextManager, AsyncGenerator, Callable
+
+
+def generator(
+    func: Callable[..., AsyncGenerator],
+) -> Callable[..., AsyncContextManager[AsyncGenerator]]:
+    @functools.wraps(func)
+    @contextlib.asynccontextmanager
+    async def wrapper(*args, **kwargs) -> AsyncGenerator[AsyncGenerator, None]:
+        gen = func(*args, **kwargs)
+        try:
+            yield gen
+        finally:
+            await gen.aclose()
+
+    return wrapper

enapter-0.25.0/src/enapter/async_/routine.py

@@ -0,0 +1,37 @@
+import abc
+import asyncio
+import contextlib
+from typing import Self
+
+
+class Routine(abc.ABC):
+
+    def __init__(self, task_group: asyncio.TaskGroup | None = None) -> None:
+        self._task_group = task_group
+        self._task: asyncio.Task | None = None
+
+    @abc.abstractmethod
+    async def _run(self) -> None:
+        pass  # pragma: no cover
+
+    async def __aenter__(self) -> Self:
+        await self.start()
+        return self
+
+    async def __aexit__(self, *_) -> None:
+        await self.stop()
+
+    async def start(self) -> None:
+        if self._task is not None:
+            raise RuntimeError("already started")
+        if self._task_group is None:
+            self._task = asyncio.create_task(self._run())
+        else:
+            self._task = self._task_group.create_task(self._run())
+
+    async def stop(self) -> None:
+        if self._task is None:
+            raise RuntimeError("not started yet")
+        self._task.cancel()
+        with contextlib.suppress(asyncio.CancelledError):
+            await self._task

enapter-0.25.0/src/enapter/cli/__init__.py

@@ -0,0 +1,6 @@
+from .command import Command
+from .subparsers import Subparsers
+
+from .app import App  # isort: skip
+
+__all__ = ["App", "Command", "Subparsers"]

enapter-0.25.0/src/enapter/cli/app.py

@@ -0,0 +1,37 @@
+import argparse
+import logging
+
+from enapter import log
+
+from . import http
+from .version_command import VersionCommand
+
+
+class App:
+
+    def __init__(self, args: argparse.Namespace) -> None:
+        self.args = args
+
+    @classmethod
+    def new(cls) -> "App":
+        parser = argparse.ArgumentParser(
+            prog="enapter", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument("-v", "--verbose", action="store_true")
+        subparsers = parser.add_subparsers(dest="command", required=True)
+        for command in [
+            http.Command,
+            VersionCommand,
+        ]:
+            command.register(subparsers)
+        return cls(args=parser.parse_args())
+
+    async def run(self) -> None:
+        log.configure(level=logging.DEBUG if self.args.verbose else logging.INFO)
+        match self.args.command:
+            case "http":
+                await http.Command.run(self.args)
+            case "version":
+                await VersionCommand.run(self.args)
+            case _:
+                raise NotImplementedError(self.args.command)

enapter-0.25.0/src/enapter/cli/command.py

@@ -0,0 +1,16 @@
+import abc
+import argparse
+
+from .subparsers import Subparsers
+
+
+class Command(abc.ABC):
+
+    @staticmethod
+    def register(subparsers: Subparsers) -> None:
+        pass
+
+    @staticmethod
+    @abc.abstractmethod
+    async def run(args: argparse.Namespace) -> None:
+        pass

enapter-0.25.0/src/enapter/cli/http/__init__.py

@@ -0,0 +1,3 @@
+from .command import Command
+
+__all__ = ["Command"]

enapter-0.25.0/src/enapter/cli/http/api/__init__.py

@@ -0,0 +1,3 @@
+from .command import Command
+
+__all__ = ["Command"]

enapter-0.25.0/src/enapter/cli/http/api/blueprint_command.py

@@ -0,0 +1,43 @@
+import argparse
+
+from enapter import cli
+
+from .blueprint_download_command import BlueprintDownloadCommand
+from .blueprint_get_command import BlueprintGetCommand
+from .blueprint_profiles_command import BlueprintProfilesCommand
+from .blueprint_upload_command import BlueprintUploadCommand
+from .blueprint_validate_command import BlueprintValidateCommand
+
+
+class BlueprintCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "blueprint", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        subparsers = parser.add_subparsers(dest="blueprint_command", required=True)
+        for command in [
+            BlueprintDownloadCommand,
+            BlueprintGetCommand,
+            BlueprintProfilesCommand,
+            BlueprintUploadCommand,
+            BlueprintValidateCommand,
+        ]:
+            command.register(subparsers)
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        match args.blueprint_command:
+            case "download":
+                await BlueprintDownloadCommand.run(args)
+            case "get":
+                await BlueprintGetCommand.run(args)
+            case "profiles":
+                await BlueprintProfilesCommand.run(args)
+            case "upload":
+                await BlueprintUploadCommand.run(args)
+            case "validate":
+                await BlueprintValidateCommand.run(args)
+            case _:
+                raise NotImplementedError(args.blueprint_command)

enapter-0.25.0/src/enapter/cli/http/api/blueprint_download_command.py

@@ -0,0 +1,41 @@
+import argparse
+import logging
+import pathlib
+
+from enapter import cli, http
+
+LOGGER = logging.getLogger(__name__)
+
+
+class BlueprintDownloadCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "download", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument("id", help="ID of the blueprint to download")
+        parser.add_argument(
+            "-o",
+            "--output",
+            type=pathlib.Path,
+            help="Output directory path",
+            default=pathlib.Path.cwd(),
+        )
+        parser.add_argument(
+            "-v",
+            "--view",
+            choices=["original", "compiled"],
+            default="original",
+            help="Blueprint view type",
+        )
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        async with http.api.Client(http.api.Config.from_env()) as client:
+            content = await client.blueprints.download(
+                args.id, view=http.api.blueprints.BlueprintView(args.view.upper())
+            )
+            output_path = args.output / f"{args.id}.zip"
+            with output_path.open("wb") as f:
+                f.write(content)

enapter-0.25.0/src/enapter/cli/http/api/blueprint_get_command.py

@@ -0,0 +1,23 @@
+import argparse
+import json
+import logging
+
+from enapter import cli, http
+
+LOGGER = logging.getLogger(__name__)
+
+
+class BlueprintGetCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "get", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument("id", help="ID of the blueprint to get")
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        async with http.api.Client(http.api.Config.from_env()) as client:
+            blueprint = await client.blueprints.get(blueprint_id=args.id)
+            print(json.dumps(blueprint.to_dto()))

enapter-0.25.0/src/enapter/cli/http/api/blueprint_profiles_command.py

@@ -0,0 +1,29 @@
+import argparse
+
+from enapter import cli
+
+from .blueprint_profiles_download_command import BlueprintProfilesDownloadCommand
+
+
+class BlueprintProfilesCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "profiles", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        subparsers = parser.add_subparsers(
+            dest="blueprint_profiles_command", required=True
+        )
+        for command in [
+            BlueprintProfilesDownloadCommand,
+        ]:
+            command.register(subparsers)
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        match args.blueprint_profiles_command:
+            case "download":
+                await BlueprintProfilesDownloadCommand.run(args)
+            case _:
+                raise NotImplementedError(args.blueprint_profiles_command)

enapter-0.25.0/src/enapter/cli/http/api/blueprint_profiles_download_command.py

@@ -0,0 +1,31 @@
+import argparse
+import logging
+import pathlib
+
+from enapter import cli, http
+
+LOGGER = logging.getLogger(__name__)
+
+
+class BlueprintProfilesDownloadCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "download", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument(
+            "-o",
+            "--output",
+            type=pathlib.Path,
+            help="Output directory path",
+            default=pathlib.Path.cwd(),
+        )
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        async with http.api.Client(http.api.Config.from_env()) as client:
+            content = await client.blueprints.download_device_profiles()
+            output_path = args.output / "device_profiles.zip"
+            with output_path.open("wb") as f:
+                f.write(content)

enapter-0.25.0/src/enapter/cli/http/api/blueprint_upload_command.py

@@ -0,0 +1,29 @@
+import argparse
+import json
+import logging
+import pathlib
+
+from enapter import cli, http
+
+LOGGER = logging.getLogger(__name__)
+
+
+class BlueprintUploadCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "upload", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument(
+            "path", type=pathlib.Path, help="Path to a directory or a zip file"
+        )
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        async with http.api.Client(http.api.Config.from_env()) as client:
+            if args.path.is_dir():
+                blueprint = await client.blueprints.upload_directory(args.path)
+            else:
+                blueprint = await client.blueprints.upload_file(args.path)
+            print(json.dumps(blueprint.to_dto()))

enapter-0.25.0/src/enapter/cli/http/api/blueprint_validate_command.py

@@ -0,0 +1,27 @@
+import argparse
+import logging
+import pathlib
+
+from enapter import cli, http
+
+LOGGER = logging.getLogger(__name__)
+
+
+class BlueprintValidateCommand(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "validate", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        parser.add_argument(
+            "path", type=pathlib.Path, help="Path to a directory or a zip file"
+        )
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        async with http.api.Client(http.api.Config.from_env()) as client:
+            if args.path.is_dir():
+                await client.blueprints.validate_directory(args.path)
+            else:
+                await client.blueprints.validate_file(args.path)

enapter-0.25.0/src/enapter/cli/http/api/command.py

@@ -0,0 +1,47 @@
+import argparse
+
+from enapter import cli
+
+from .blueprint_command import BlueprintCommand
+from .command_command import CommandCommand
+from .device_command import DeviceCommand
+from .rule_engine_command import RuleEngineCommand
+from .site_command import SiteCommand
+from .telemetry_command import TelemetryCommand
+
+
+class Command(cli.Command):
+
+    @staticmethod
+    def register(parent: cli.Subparsers) -> None:
+        parser = parent.add_parser(
+            "api", formatter_class=argparse.ArgumentDefaultsHelpFormatter
+        )
+        subparsers = parser.add_subparsers(dest="api_command", required=True)
+        for command in [
+            BlueprintCommand,
+            CommandCommand,
+            DeviceCommand,
+            RuleEngineCommand,
+            SiteCommand,
+            TelemetryCommand,
+        ]:
+            command.register(subparsers)
+
+    @staticmethod
+    async def run(args: argparse.Namespace) -> None:
+        match args.api_command:
+            case "blueprint":
+                await BlueprintCommand.run(args)
+            case "command":
+                await CommandCommand.run(args)
+            case "device":
+                await DeviceCommand.run(args)
+            case "rule-engine":
+                await RuleEngineCommand.run(args)
+            case "site":
+                await SiteCommand.run(args)
+            case "telemetry":
+                await TelemetryCommand.run(args)
+            case _:
+                raise NotImplementedError(args.api_command)

enapter-0.25.0/src/enapter/cli/http/api/command_arguments.py

@@ -0,0 +1,11 @@
+import argparse
+import json
+
+
+def parse_command_arguments(arguments_string: str | None) -> dict:
+    if arguments_string is None:
+        return {}
+    try:
+        return json.loads(arguments_string)
+    except json.JSONDecodeError as e:
+        raise argparse.ArgumentTypeError(f"Decode JSON: {e.msg}")