shvcli-ell 0.1.0__tar.gz

shvcli_ell-0.1.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: shvcli-ell
+Version: 0.1.0
+Summary: Silicon Heaven CLI Elektroline extension
+Author: Elektroline a.s.
+Project-URL: source, https://gitlab.com/elektroline-predator/shvcli-ell
+Project-URL: changelog, https://gitlab.com/elektroline-predator/shvcli-ell/-/blob/master/CHANGELOG.md
+Project-URL: issues, https://gitlab.com/elektroline-predator/shvcli-ell/-/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: shvcli>=0.7.0
+
+Silicon Heaven CLI Elektroline extension
+========================================
+
+The extension for the Silicon Heaven CLI access application to provide utilities
+to work with Elektroline developed SHV systems.
+
+* `📃 Sources <https://gitlab.com/elektroline-predator/shvcli-ell>`__
+* `⁉️ Issue tracker <https://gitlab.com/elektroline-predator/shvcli-ell/-/issues>`__
+* `Silicon Heaven CLI <https://gitlab.com/silicon-heaven/shvcli>`__

shvcli_ell-0.1.0/README.rst

@@ -0,0 +1,9 @@
+Silicon Heaven CLI Elektroline extension
+========================================
+
+The extension for the Silicon Heaven CLI access application to provide utilities
+to work with Elektroline developed SHV systems.
+
+* `📃 Sources <https://gitlab.com/elektroline-predator/shvcli-ell>`__
+* `⁉️ Issue tracker <https://gitlab.com/elektroline-predator/shvcli-ell/-/issues>`__
+* `Silicon Heaven CLI <https://gitlab.com/silicon-heaven/shvcli>`__

shvcli_ell-0.1.0/pyproject.toml

@@ -0,0 +1,78 @@
+[project]
+name = "shvcli-ell"
+version = "0.1.0"
+description = "Silicon Heaven CLI Elektroline extension"
+readme = "README.rst"
+authors = [
+  { name="Elektroline a.s." },
+]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+requires-python = ">=3.11"
+dependencies = [
+  "shvcli >= 0.7.0",
+]
+
+[project.urls]
+source = "https://gitlab.com/elektroline-predator/shvcli-ell"
+changelog = "https://gitlab.com/elektroline-predator/shvcli-ell/-/blob/master/CHANGELOG.md"
+issues = "https://gitlab.com/elektroline-predator/shvcli-ell/-/issues"
+
+[project.entry-points."shvcli.plugins"]
+ell = "shvcli_ell.plugin"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+[tool.setuptools.cmdclass]
+build_py = "shvcli_ell.__setuptools__.BuildPy"
+
+[tool.ruff]
+target-version = "py311"
+[tool.ruff.lint]
+select = [
+  "F", "E", "W", "I", "N", "D", "UP", "YTT", "ANN", "ASYNC", "ASYNC1", "S", "BLE",
+  "B", "A", "COM", "PL", "RUF"
+]
+ignore = [
+  # Magic methods have defined behavior so what is there to document. __init__
+  # should be documented in class docstring.
+  "D105", "D107",
+  # These have conflicting rules.
+  "D203", "D213",
+  # Ignore too long lines (format tackles that)
+  "E501",
+  # It is nice that assert should not be used for input checking but it can be
+  # also used for internal consistency checking.
+  "S101", "B011",
+  # subprocess can be insecurely used but not is insecure by design
+  "S404", "S603", "S607",
+  # Catching Exception is valid and safe in some cases and thus should be allowed
+  "BLE001",
+  # Conflict with formatter
+  "COM812",
+  # Remove too-many limit for more complex code.
+  "PLR0904", "PLR0911", "PLR0912", "PLR0913", "PLR0917", "PLR2004", "PLR1702",
+  # This seems like a wrong rule
+  "PLW1641",
+]
+preview = true
+[tool.ruff.lint.per-file-ignores]
+"docs/conf.py" = ["D100", "D103", "A001", "ANN201", "ANN001"]
+[tool.ruff.format]
+docstring-code-format = true
+preview = true
+
+[tool.mypy]
+python_version = "3.11"
+ignore_missing_imports = true
+disallow_untyped_defs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+warn_unreachable = true

shvcli_ell-0.1.0/setup.cfg

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

shvcli_ell-0.1.0/shvcli_ell/__init__.py

@@ -0,0 +1,8 @@
+"""Simple counter of strings of this package name.
+
+This package is base for the packages to be implemented.
+"""
+
+from .__version__ import VERSION
+
+__all__ = ["VERSION"]

shvcli_ell-0.1.0/shvcli_ell/__setuptools__.py

@@ -0,0 +1,18 @@
+"""Setuptools hook used to replace __version__.py file."""
+
+import pathlib
+
+from setuptools.command.build_py import build_py as _build_py
+
+
+class BuildPy(_build_py):
+    """Custom package build step."""
+
+    def run(self) -> None:  # noqa: D102
+        package = pathlib.Path(__file__).parent.name
+        buildlib = pathlib.Path(self.build_lib) / package
+        buildlib.mkdir(parents=True, exist_ok=True)
+        version = self.distribution.metadata.version
+        (buildlib / "__version__.py").write_text(f'VERSION = "{version}"\n')
+        super().run()
+        (buildlib / "__setuptools__.py").unlink()

shvcli_ell-0.1.0/shvcli_ell/__version__.py

@@ -0,0 +1,24 @@
+"""The loader of the version for source file only installation.
+
+It looks for pyproject.toml file in upper directory and loads version from
+there.
+
+This file is overwritten during distribution build to contain only constant
+VERSION. Please see __setuptools__.py for details.
+"""
+
+import pathlib
+import tomllib
+
+
+def _get_version() -> str:
+    pyproject = pathlib.Path(__file__).parent.parent / "pyproject.toml"
+    if pyproject.exists():
+        with pyproject.open("rb") as f:
+            res = tomllib.load(f)["project"]["version"]
+            if isinstance(res, str):
+                return res
+    return "unknown"
+
+
+VERSION = _get_version()

shvcli_ell-0.1.0/shvcli_ell/plugin.py

@@ -0,0 +1,6 @@
+"""The top level loaded for the plugin."""
+
+import importlib
+
+importlib.import_module(".timesync", __package__)
+importlib.import_module(".timezone", __package__)

shvcli_ell-0.1.0/shvcli_ell/timesync.py

@@ -0,0 +1,56 @@
+"""The builtin to sync time of NuttX based devices."""
+
+import collections.abc
+import datetime
+
+from prompt_toolkit.completion import Completion
+from shvcli import Builtin, Builtins, Client, CliItems, State, Tree
+from shvcli.tools.complet import comp_path
+
+
+class BuiltinTimeSync(Builtin):
+    """The builtin for time synchronization of ``utcTime`` with local one."""
+
+    def __init__(self, builtins: Builtins, state: State) -> None:
+        super().__init__(builtins, state)
+        builtins["timesync"] = self
+
+    @property
+    def description(self) -> tuple[str, str]:  # noqa: D102
+        return "[PATH]", "Synchronize the time of the board with the local time."
+
+    def completion(  # noqa: D102
+        self, items: CliItems, client: Client
+    ) -> collections.abc.Iterable[Completion]:
+        yield from comp_path(items.param, self.state.path, Tree(self.state), "")
+
+    async def completion_async(  # noqa: D102
+        self, items: CliItems, client: Client
+    ) -> collections.abc.AsyncGenerator[Completion, None]:
+        await client.probe(
+            items.path_param if items.param.endswith("/") else items.path_param.parent
+        )
+
+        async for res in super().completion_async(items, client):
+            yield res
+
+    async def run(self, items: CliItems, client: Client) -> None:  # noqa: PLR6301, D102
+        path = items.path_param
+        if path.name != "utcTime":
+            path /= "utcTime"
+        got = await client.call(str(path), "get")
+        if not isinstance(got, datetime.datetime):
+            print(f"Unexpected result of {path}:get: {got}")
+            return
+
+        now = datetime.datetime.now(datetime.UTC)
+        diff = now - got
+        drift = datetime.timedelta(milliseconds=500)
+        if not (-drift <= diff <= drift):
+            await client.call(str(path), "set", now)
+            print(f"Time synchronized. The difference: {diff}")
+        else:
+            print(
+                "Time is syncrhonized withing half a second tolerance. "
+                f"The difference: {diff}"
+            )

shvcli_ell-0.1.0/shvcli_ell/timezone.py

@@ -0,0 +1,56 @@
+"""The builtin to set local time time of NuttX based devices."""
+
+import collections.abc
+import pathlib
+import zoneinfo
+
+from prompt_toolkit.completion import Completion
+from prompt_toolkit.validation import ValidationError
+from shvcli import Builtin, Builtins, Client, CliItems, State
+from shvcli.file import copy_file
+from shvcli.tools.complet import comp_from
+
+
+class BuiltinTimeSync(Builtin):
+    """The builtin for setting local time zone."""
+
+    def __init__(self, builtins: Builtins, state: State) -> None:
+        super().__init__(builtins, state)
+        builtins["timezone"] = self
+
+    @property
+    def description(self) -> tuple[str, str]:  # noqa: D102
+        return (
+            "[TZ]",
+            "Upload the given time zone (or local time zone in default).",
+        )
+
+    def completion(  # noqa: PLR6301, D102
+        self, items: CliItems, client: Client
+    ) -> collections.abc.Iterable[Completion]:
+        yield from comp_from(items.param, zoneinfo.available_timezones())
+
+    def validate(self, items: CliItems, client: Client) -> None:  # noqa: D102
+        param = items.param
+        if param and self._zonefile(items.param) is None:
+            raise ValidationError(message=f"No such zoneinfo: {param}")
+
+    async def run(self, items: CliItems, client: Client) -> None:  # noqa: D102
+        dest = items.path
+        if dest.name != "timeZone":
+            dest /= "timeZone"
+
+        param = items.param
+        src = self._zonefile(param) if param else pathlib.Path("/etc/localtime")
+        if src is not None:
+            await copy_file(client, src, dest)
+        else:
+            print(f"No such zoneinfo: {param}")
+
+    @staticmethod
+    def _zonefile(param: str) -> pathlib.Path | None:
+        for tzpath in map(pathlib.Path, zoneinfo.TZPATH):
+            path = tzpath / param
+            if path.is_file():
+                return path
+        return None

shvcli_ell-0.1.0/shvcli_ell.egg-info/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: shvcli-ell
+Version: 0.1.0
+Summary: Silicon Heaven CLI Elektroline extension
+Author: Elektroline a.s.
+Project-URL: source, https://gitlab.com/elektroline-predator/shvcli-ell
+Project-URL: changelog, https://gitlab.com/elektroline-predator/shvcli-ell/-/blob/master/CHANGELOG.md
+Project-URL: issues, https://gitlab.com/elektroline-predator/shvcli-ell/-/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: shvcli>=0.7.0
+
+Silicon Heaven CLI Elektroline extension
+========================================
+
+The extension for the Silicon Heaven CLI access application to provide utilities
+to work with Elektroline developed SHV systems.
+
+* `📃 Sources <https://gitlab.com/elektroline-predator/shvcli-ell>`__
+* `⁉️ Issue tracker <https://gitlab.com/elektroline-predator/shvcli-ell/-/issues>`__
+* `Silicon Heaven CLI <https://gitlab.com/silicon-heaven/shvcli>`__

shvcli_ell-0.1.0/shvcli_ell.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.rst
+pyproject.toml
+shvcli_ell/__init__.py
+shvcli_ell/__setuptools__.py
+shvcli_ell/__version__.py
+shvcli_ell/plugin.py
+shvcli_ell/py.typed
+shvcli_ell/timesync.py
+shvcli_ell/timezone.py
+shvcli_ell.egg-info/PKG-INFO
+shvcli_ell.egg-info/SOURCES.txt
+shvcli_ell.egg-info/dependency_links.txt
+shvcli_ell.egg-info/entry_points.txt
+shvcli_ell.egg-info/requires.txt
+shvcli_ell.egg-info/top_level.txt

shvcli_ell-0.1.0/shvcli_ell.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

shvcli_ell-0.1.0/shvcli_ell.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[shvcli.plugins]
+ell = shvcli_ell.plugin

shvcli_ell-0.1.0/shvcli_ell.egg-info/requires.txt

@@ -0,0 +1 @@
+shvcli>=0.7.0

shvcli_ell-0.1.0/shvcli_ell.egg-info/top_level.txt

@@ -0,0 +1 @@
+shvcli_ell