cgse-tools 2024.1.3__tar.gz

cgse_tools-2024.1.3/.gitignore

@@ -0,0 +1,20 @@
+.python-version
+.envrc
+
+build
+dist
+
+.DS_Store
+
+__pycache__
+.pytest_cache
+
+.env
+.venv
+venv
+
+.idea
+
+**/*.egg-info
+
+uv.lock

cgse_tools-2024.1.3/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: cgse-tools
+Version: 2024.1.3
+Summary: Tools for CGSE
+Author: IVS KU Leuven
+Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
+License-Expression: MIT
+Keywords: CGSE,Common-EGSE,hardware testing,software framework
+Requires-Python: >=3.9
+Requires-Dist: cgse-core
+Requires-Dist: rich
+Requires-Dist: textual
+Provides-Extra: dev
+Requires-Dist: pipdeptree; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: tomlkit; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Tools for the CGSE framework

cgse_tools-2024.1.3/README.md

@@ -0,0 +1 @@
+# Tools for the CGSE framework

cgse_tools-2024.1.3/pyproject.toml

@@ -0,0 +1,63 @@
+[project]
+name = "cgse-tools"
+version = "2024.1.3"
+description = "Tools for CGSE"
+authors = [
+    {name = "IVS KU Leuven"}
+]
+maintainers = [
+    {name = "Rik Huygen", email = "rik.huygen@kuleuven.be"},
+    {name = "Sara Regibo", email = "sara.regibo@kuleuven.be"}
+]
+readme = {"file" = "README.md", "content-type" = "text/markdown"}
+requires-python = ">=3.9"
+license = "MIT"
+keywords = [
+    "CGSE",
+    "Common-EGSE",
+    "hardware testing",
+    "software framework"
+]
+dependencies = [
+    "cgse-core",
+    "textual",
+    "rich",
+]
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-mock", "pytest-cov"]
+dev = ["pipdeptree", "tomlkit", "ruff"]
+
+[project.scripts]
+cgse-status = "egse.tools.status:main"
+
+[project.entry-points."cgse.version"]
+cgse-tools = 'egse.tools'
+
+# Examples of how to provide plugins for the `cgse` command
+
+[project.entry-points."cgse.plugins"]
+foo = 'scripts.cgse_plugins:foo'
+
+[project.entry-points."cgse.service.plugins"]
+xxx = 'scripts.cgse_service_plugins:xxx'
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/tests",
+    "/pytest.ini",
+    "/.gitignore",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/egse"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+extend-select = ["E501"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

cgse_tools-2024.1.3/src/egse/tools/status.py

@@ -0,0 +1,86 @@
+import textwrap
+
+import rich
+from rich.text import Text
+from textual.app import App, ComposeResult
+from textual.widgets import Header, Footer
+from textual.widgets import Static, Label
+
+
+class StatusApp(App):
+    """A Textual app to present status information."""
+
+    BINDINGS = [("d", "toggle_dark", "Toggle dark mode")]
+
+    def compose(self) -> ComposeResult:
+        """Create child widgets for the app."""
+        yield Header()
+        yield Static(get_log_cs_status())
+        yield Static(get_sm_cs_status())
+        yield Label(get_cm_cs_status())
+        yield Footer()
+
+    def action_toggle_dark(self) -> None:
+        """An action to toggle dark mode."""
+        self.dark = not self.dark
+
+
+def get_log_cs_status():
+
+    from egse.logger import send_request
+
+    response = send_request("status")
+
+    if response.get("status") == "ACK":
+        text = textwrap.dedent(
+            f"""\
+            Log Manager:
+                Status: [green]active[/]
+                Level [grey50](file)[/]: {response.get('file_logger_level')}
+                Level [grey50](stdout)[/]: {response.get('stream_logger_level')}
+                Log file location: {response.get('file_logger_location')}
+            """
+        )
+    else:
+        text = "Log Manager Status: [red]not active"
+
+    return text
+
+
+def get_cm_cs_status():
+
+    from egse.confman import get_status
+    return Text.from_markup(get_status())
+
+
+def get_sm_cs_status():
+
+    from egse.storage import get_status
+    return Text.from_markup(get_status())
+
+
+def main():
+    from rich import print
+
+    try:
+        # importing 'egse' only will not cause an import error because this package installs
+        # 'egse.tools'
+        import egse.confman
+        import egse.tools
+    except ImportError as exc:
+        print(
+            textwrap.dedent(
+                f"""\
+                [red]ERROR: Import error on the egse module.[/red] You must have the CGSE package
+                installed in the Python environment you are running this tool from.
+                """
+            ),
+        flush=True)
+        print(exc)
+        return
+
+    app = StatusApp()
+    app.run()
+
+if __name__ == "__main__":
+    main()

cgse_tools-2024.1.3/src/scripts/cgse_plugins.py

@@ -0,0 +1,9 @@
+# An example plugin for a major command on the `cgse` script in `cgse-core`.
+import click
+
+
+@click.command()
+@click.option("--full", is_flag=True, help="some option")
+def foo(full: bool = False):
+    """Example of major command plugin for `cgse`."""
+    print(f"execute foo --{full=}")

cgse_tools-2024.1.3/src/scripts/cgse_service_plugins.py

@@ -0,0 +1,10 @@
+# An example plugin for the `cgse {start,stop,status} service` command from `cgse-core`.
+
+import click
+
+
+@click.command()
+@click.option("--xxx-plus", is_flag=True, help="some option")
+@click.pass_context
+def xxx(ctx, xxx_plus: bool = False):
+    print(f"{ctx.obj['action']} XXX services with {xxx_plus = }")