phobos-templates-utils 0.0.1__tar.gz

phobos_templates_utils-0.0.1/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: phobos-templates-utils
+Version: 0.0.1
+Summary: Package with utilities for Phobos Templates scripts
+Author-email: Matheus Castello <matheus@castello.eng.br>
+Project-URL: Homepage, https://github.com/gaiaBuildSystem/vscode-phobos-templates
+Project-URL: Issues, https://github.com/gaiaBuildSystem/vscode-phobos-templates/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: torizon-io-api
+Requires-Dist: requests
+Requires-Dist: pyyaml
+Requires-Dist: debugpy
+Requires-Dist: pkginfo>=1.12
+
+# Phobos Templates Utils
+
+This package contains a set of utilities to help the scripts that generate the Torizon OS applications and containers.
+
+If you want to know more about check [Toradex developer website](https://developer.toradex.com/torizon/application-development/ide-extension/).

phobos_templates_utils-0.0.1/README.md

@@ -0,0 +1,5 @@
+# Phobos Templates Utils
+
+This package contains a set of utilities to help the scripts that generate the Torizon OS applications and containers.
+
+If you want to know more about check [Toradex developer website](https://developer.toradex.com/torizon/application-development/ide-extension/).

phobos_templates_utils-0.0.1/phobos_templates_utils.egg-info/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: phobos-templates-utils
+Version: 0.0.1
+Summary: Package with utilities for Phobos Templates scripts
+Author-email: Matheus Castello <matheus@castello.eng.br>
+Project-URL: Homepage, https://github.com/gaiaBuildSystem/vscode-phobos-templates
+Project-URL: Issues, https://github.com/gaiaBuildSystem/vscode-phobos-templates/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: torizon-io-api
+Requires-Dist: requests
+Requires-Dist: pyyaml
+Requires-Dist: debugpy
+Requires-Dist: pkginfo>=1.12
+
+# Phobos Templates Utils
+
+This package contains a set of utilities to help the scripts that generate the Torizon OS applications and containers.
+
+If you want to know more about check [Toradex developer website](https://developer.toradex.com/torizon/application-development/ide-extension/).

phobos_templates_utils-0.0.1/phobos_templates_utils.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+pyproject.toml
+phobos_templates_utils.egg-info/PKG-INFO
+phobos_templates_utils.egg-info/SOURCES.txt
+phobos_templates_utils.egg-info/dependency_links.txt
+phobos_templates_utils.egg-info/requires.txt
+phobos_templates_utils.egg-info/top_level.txt
+torizon_templates_utils/__init__.py
+torizon_templates_utils/animations.py
+torizon_templates_utils/args.py
+torizon_templates_utils/colors.py
+torizon_templates_utils/debug.py
+torizon_templates_utils/errors.py
+torizon_templates_utils/network.py
+torizon_templates_utils/tasks.py

phobos_templates_utils-0.0.1/phobos_templates_utils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

phobos_templates_utils-0.0.1/phobos_templates_utils.egg-info/requires.txt

@@ -0,0 +1,5 @@
+torizon-io-api
+requests
+pyyaml
+debugpy
+pkginfo>=1.12

phobos_templates_utils-0.0.1/phobos_templates_utils.egg-info/top_level.txt

@@ -0,0 +1 @@
+torizon_templates_utils

phobos_templates_utils-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["setuptools>=70.0", "pkginfo>=1.12"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "phobos-templates-utils"
+version = "0.0.1"
+authors = [
+  { name="Matheus Castello", email="matheus@castello.eng.br" },
+]
+description = "Package with utilities for Phobos Templates scripts"
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: POSIX :: Linux",
+]
+dependencies = [
+    "torizon-io-api",
+    "requests",
+    "pyyaml",
+    "debugpy",
+    "pkginfo>=1.12"
+]
+
+[tool.setuptools]
+license-files = []
+
+[project.urls]
+Homepage = "https://github.com/gaiaBuildSystem/vscode-phobos-templates"
+Issues = "https://github.com/gaiaBuildSystem/vscode-phobos-templates/issues"

phobos_templates_utils-0.0.1/setup.cfg

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

phobos_templates_utils-0.0.1/torizon_templates_utils/animations.py

@@ -0,0 +1,67 @@
+import sys
+import time
+import threading
+from itertools import cycle
+
+def run_command_with_wait_animation(call, *args):
+    anima_frames = ["🕐", "🕑", "🕒", "🕓", "🕔", "🕕", "🕖", "🕗", "🕘", "🕙", "🕚", "🕛"]
+
+    def animate():
+        for frame in cycle(anima_frames):
+            if not running[0]:
+                break
+            sys.stdout.write(f"\r{frame} :: RUNNING PLEASE WAIT :: {frame}")
+            sys.stdout.flush()
+            time.sleep(0.1)
+
+        # Clear the line
+        sys.stdout.write("\r\x1b[2K")
+
+        if running[1]:
+            sys.stdout.write("❌ ::    TASK FAILED    :: ❌\n")
+        else:
+            sys.stdout.write("✅ ::    TASK COMPLETED    :: ✅\n")
+
+        # clear anything the command printed below the animation line
+        # while it was pinned (e.g. the scan live device list)
+        sys.stdout.write("\x1b[J")
+        sys.stdout.flush()
+
+    def target():
+        nonlocal output
+        try:
+            output = call(*args)
+        except Exception as e:
+            output = e
+            running[1] = True
+        finally:
+            running[0] = False
+
+    # [0] is if it's running [1] if it has failed
+    running = [True, False]
+    output = None
+
+    animation_thread = threading.Thread(target=animate)
+    command_thread = threading.Thread(target=target)
+
+    animation_thread.start()
+    command_thread.start()
+
+    command_thread.join()
+    animation_thread.join()
+
+    if isinstance(output, Exception):
+        raise output
+
+    return output
+
+
+# # Example usage
+# def example_script(duration):
+#     time.sleep(duration)
+#     return "Task finished"
+
+# if __name__ == "__main__":
+#     print("LET'S RUN A SCRIPT THAT TAKES 5 SECONDS TO FINISH")
+#     result = run_command_in_background_with_wait_animation(example_script, 5)
+#     print(result)

phobos_templates_utils-0.0.1/torizon_templates_utils/args.py

@@ -0,0 +1,83 @@
+
+import sys
+from typing import TypeVar, Type
+from torizon_templates_utils.errors import Error, Error_Out
+
+T = TypeVar('T')
+
+def get_arg_not_empty(index: int) -> str:
+    """
+    Get an argument from the command line.
+    If the argument is an empty string, an error is raised.
+    """
+    _arg = sys.argv[index]
+
+    if _arg == "":
+        Error_Out(
+            "Error: Argument cannot be empty",
+            Error.EUSER
+        )
+
+    return _arg
+
+
+def get_optional_arg(index: int, default: T) -> T | bool | str:
+    """
+    Get an optional argument from the command line.
+    If the argument is not provided, the default value is returned.
+    """
+    if len(sys.argv) > index:
+        # sys.argv return string
+        # we need to return T
+        # FIXME: this only convert string to bool for now
+        if type(default) is bool:
+            if sys.argv[index] == "True" or sys.argv[index] == "true" or sys.argv[index] == "1":
+                return True
+            else:
+                return False
+
+        return sys.argv[index]
+
+    return default
+
+
+def get_arg_iterative(
+        index: int, prompt: str, default_type: Type, default: T | None = None, iterative: bool = False
+    ) -> T | None | bool | str:
+    """
+    Get an argument from the command line.
+    If the argument is not provided, an error is raised.
+    """
+    if len(sys.argv) > index:
+        if default_type is bool:
+            if sys.argv[index] == "True":
+                return True
+            else:
+                return False
+
+        return sys.argv[index]
+    elif default != None:
+        return default
+    elif iterative:
+        _input = input(prompt)
+        if _input == "":
+            Error_Out(
+                "Error: Argument cannot be empty",
+                Error.EUSER
+            )
+        else:
+            if default_type is bool:
+                if _input == "True":
+                    return True
+                else:
+                    return False
+
+            return _input
+
+    else:
+        Error_Out(
+            f"Error: Argument for prompt [{prompt}] not provided",
+            Error.EUSER
+        )
+
+    return default

phobos_templates_utils-0.0.1/torizon_templates_utils/colors.py

@@ -0,0 +1,56 @@
+
+import builtins
+import enum
+
+class Color(enum.IntEnum):
+    NONE = 0
+    BLACK = 30
+    RED = 31
+    GREEN = 32
+    YELLOW = 33
+    BLUE = 34
+    MAGENTA = 35
+    CYAN = 36
+    WHITE = 37
+
+class BgColor(enum.IntEnum):
+    NONE = 0
+    BLACK = 40
+    RED = 41
+    BRIGTH_RED = 101
+    GREEN = 42
+    BRIGTH_GREEN = 102
+    YELLOW = 43
+    BRIGTH_YELLOW = 103
+    BLUE = 44
+    BRIGTH_BLUE = 104
+    MAGENTA = 45
+    BRIGTH_MAGENTA = 105
+    CYAN = 46
+    BRIGTH_CYAN = 106
+    WHITE = 47
+    BRIGTH_WHITE = 107
+
+# override print to have color and background color
+def print(
+        *args,
+        color: Color = Color.NONE,
+        bg_color: BgColor = BgColor.NONE,
+        **kwargs
+) -> None:
+    _color: int = color.value
+    _bg_color: int = bg_color.value
+
+    start_escape = ""
+
+    if _color != 0 and _bg_color != 0:
+        start_escape += f"\033[{_color};{_bg_color}m"
+    elif _color != 0:
+        start_escape += f"\033[{_color}m"
+    elif _bg_color != 0:
+        start_escape += f"\033[{_bg_color}m"
+
+    end_escape = "\033[0m"
+
+    text = ' '.join(map(str, args))
+    builtins.print(f'{start_escape}{text}{end_escape}', **kwargs)

phobos_templates_utils-0.0.1/torizon_templates_utils/debug.py

@@ -0,0 +1,22 @@
+# pylint: disable=missing-function-docstring
+# pylint: disable=missing-module-docstring
+import debugpy # type: ignore[import-untyped]
+
+DEBUG_INITIALIZED = False
+
+def vscode_prepare(port: int = 5679) -> None:
+    global DEBUG_INITIALIZED
+
+    if DEBUG_INITIALIZED:
+        return
+
+    print("__debugpy__")
+    debugpy.listen(("0.0.0.0", port))
+    print("__debugpy__ go")
+    debugpy.wait_for_client()
+    print(f"__debugpy__ is connected [{debugpy.is_client_connected()}]")
+
+    DEBUG_INITIALIZED = True
+
+def breakpoint() -> None:
+    debugpy.breakpoint()

phobos_templates_utils-0.0.1/torizon_templates_utils/errors.py

@@ -0,0 +1,58 @@
+
+import sys
+from enum import Enum
+from torizon_templates_utils.colors import Color, BgColor, print
+
+class _error_struct:
+    code: int
+    message: str
+
+    def __init__(self, code: int, message: str):
+        self.code = code
+        self.message = message
+
+# Standard Unix errors. There may be other standard error codes also:
+# https://github.com/kaushalparikh/nuttx/blob/master/include/errno.h
+class Error(Enum):
+    ENOCONF = _error_struct(
+        1, "Not configured"
+    )
+    EINVAL = _error_struct(
+        22, "Invalid argument"
+    )
+    ENOPKG = _error_struct(
+        65, "Package not installed"
+    )
+    EUSER = _error_struct(
+        69, "User fault"
+    )
+    EABORT = _error_struct(
+        170, "Abort"
+    )
+    ETASKEXEC = _error_struct(
+        310, "Task execution error"
+    )
+    ENOFOUND = _error_struct(
+        404, "Not found"
+    )
+    EFAIL = _error_struct(
+        500, "Failed"
+    )
+    EUNKNOWN = _error_struct(
+        666, "Unknown error"
+    )
+    ETOMCRUISE = _error_struct(
+        999, "Impossible condition"
+    )
+
+
+def Error_Out(msg: str, error: Error) -> None:
+    print(f"\n{msg}", color=Color.RED)
+    print(f"Error cause: {error.value.message}\n", color=Color.RED)
+    sys.exit(error.value.code)
+
+
+def last_return_code() -> int:
+    # we are ignoring the type here because this will get the current
+    # xonsh shell instance
+    return __xonsh__.last.returncode # type: ignore

phobos_templates_utils-0.0.1/torizon_templates_utils/network.py

@@ -0,0 +1,35 @@
+
+import os
+import re
+import subprocess
+
+
+def get_host_ip():
+    if 'WSL_DISTRO_NAME' in os.environ and os.environ['WSL_DISTRO_NAME'] != '':
+        command = ["/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe", "-c", '(Get-NetIPAddress -AddressFamily IPv4 -InterfaceAlias (Get-NetRoute -DestinationPrefix "0.0.0.0/0").InterfaceAlias).IPAddress']
+
+        # if inside a container we need to run the command in the host
+        if "APOLLOX_CONTAINER" in os.environ:
+            command = [
+                "sudo", "nsenter", "-t", "1", "-m", "-u", "-n", "-i",
+                "--",
+                "/mnt/c/Windows/System32/WindowsPowerShell/v1.0/powershell.exe", "-c", '(Get-NetIPAddress -AddressFamily IPv4 -InterfaceAlias (Get-NetRoute -DestinationPrefix "0.0.0.0/0").InterfaceAlias).IPAddress'
+            ]
+
+        result = subprocess.run(command, capture_output=True, text=True)
+        ip_address = re.search(r'((1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])\.){3}(1?[0-9][0-9]?|2[0-4][0-9]|25[0-5])', result.stdout)
+        if ip_address:
+            return ip_address.group(0)
+    else:
+        command = ["hostname", "-I"]
+
+        # if inside a container we need to run the command in the host
+        if "APOLLOX_CONTAINER" in os.environ:
+            command = [
+                "sudo", "nsenter", "-t", "1", "-m", "-u", "-n", "-i",
+                "--",
+                "hostname", "-I"
+            ]
+
+        result = subprocess.run(command, capture_output=True, text=True)
+        return result.stdout.split()[0]