cgse-tools 2025.0.7__py3-none-any.whl → 2025.0.8.dev2__py3-none-any.whl

cgse_tools/cgse_commands.py

@@ -0,0 +1,106 @@
+import re
+import subprocess
+import sys
+from pathlib import Path
+from typing import Annotated
+
+import rich
+import typer
+
+app = typer.Typer()
+
+
+@app.command()
+def top():
+    """
+    A top-like interface for core services and device control servers.
+
+    Not yet implemented.
+    """
+    print("This fancy top is not yet implemented.")
+
+
+show = typer.Typer(help="Show information about settings, environment, setup, ...", no_args_is_help=True)
+
+
+@show.command(name="settings")
+def show_settings():
+    proc = subprocess.Popen(
+        [sys.executable, "-m", "egse.settings"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE
+    )
+    stdout, stderr = proc.communicate()
+    rich.print(stdout.decode(), end='')
+    if stderr:
+        rich.print(f"[red]{stderr.decode()}[/]")
+
+
+@show.command(name="env")
+def show_env(
+        mkdir: Annotated[bool, typer.Option(help="Create the missing folder")] = None,
+        full: Annotated[bool, typer.Option(help="Provide additional info")] = None,
+        doc: Annotated[bool, typer.Option(help="Provide documentation on environment variables")] = None,
+):
+    options = [opt for opt, flag in [("--mkdir", mkdir), ("--full", full), ("--doc", doc)] if flag]
+
+    cmd = [sys.executable, "-m", "egse.env"]
+    cmd += options if options else []
+
+    proc = subprocess.Popen(
+        cmd,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE
+    )
+    stdout, stderr = proc.communicate()
+    rich.print(stdout.decode(), end='')
+    if stderr:
+        rich.print(f"[red]{stderr.decode()}[/]")
+
+
+check = typer.Typer(help="Check installation, settings, required files, etc.", no_args_is_help=True)
+
+
+@check.command(name="setups")
+def check_setups():
+    """Perform a number of checks on the SETUP files."""
+
+    # What can we check with respect to the setups?
+    #
+    # - CONF_DATA_LOCATION
+
+    from egse.env import get_conf_data_location
+    from egse.env import get_site_id
+    from egse.config import find_files
+
+    any_errors = 0
+
+    conf_data_location = get_conf_data_location()
+    site_id = get_site_id()
+
+    # ---------- check if the <PROJECT>_CONF_DATA_LOCATION is set
+
+    if not conf_data_location:
+        any_errors += 1
+        rich.print("[red]The location of the configuration data can not be determined, check your environment.[/]")
+
+    if not Path(conf_data_location).exists():
+        any_errors += 1
+        rich.print(f"[red]The location of the configuration data doesn't exist: {conf_data_location!s}[/]")
+
+    # ---------- check if there is at least one SETUP in the configuration data folder
+
+    files = list(find_files("SETUP*.yaml", root=conf_data_location))
+
+    if not files:
+        any_errors += 1
+        rich.print(f"[red]No SETUP files were found at {conf_data_location}[/]")
+
+    regex = re.compile(f"SETUP_{site_id}_00000_.*.yaml")
+
+    if not any(True for file in files if regex.search(str(file))):
+        any_errors += 1
+        rich.print(f"[red]The is no Zero SETUP for {site_id} in {conf_data_location}[/]")
+
+    if not any_errors:
+        rich.print("[green]everything seems to be ok.[/]")

cgse_tools/cgse_services.py

@@ -0,0 +1,28 @@
+# An example plugin for the `cgse {start,stop,status} service` command from `cgse-core`.
+#
+import rich
+import typer
+
+dev_x = typer.Typer(
+    name="dev-x",
+    help="device-x is an imaginary device that serves as an example",
+    no_args_is_help=True
+)
+
+
+@dev_x.command(name="start")
+def start_dev_x():
+    """Start the dev-x service."""
+    rich.print("Starting service dev_x")
+
+
+@dev_x.command(name="stop")
+def stop_dev_x():
+    """Stop the dev-x service."""
+    rich.print("Terminating service dev_x")
+
+
+@dev_x.command(name="status")
+def status_dev_x():
+    """Print status information on the dev-x service."""
+    rich.print("Printing the status of dev_x")

{cgse_tools-2025.0.7.dist-info → cgse_tools-2025.0.8.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse-tools
-Version: 2025.0.7
+Version: 2025.0.8.dev2
 Summary: Tools for CGSE
 Author: IVS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>

cgse_tools-2025.0.8.dev2.dist-info/RECORD

@@ -0,0 +1,8 @@
+cgse_tools/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cgse_tools/cgse_commands.py,sha256=Vh9veF8rh3hCzv6try_T7Jzv-u_z4-8qGJ3w81ZQ3NM,3093
+cgse_tools/cgse_services.py,sha256=ZERds5uCHuR5_R4YpBkc2yUTGImtVdKlItherlfL5IM,661
+egse/tools/status.py,sha256=2PFjU760X-E2aeLI5sWOZJ_rqHWCG6YwjmqreYpJ6_c,2188
+cgse_tools-2025.0.8.dev2.dist-info/METADATA,sha256=BOt9sEs2HhDn6dVjFGNsbfEzMknD-8kC1RIYbPW7AIc,613
+cgse_tools-2025.0.8.dev2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cgse_tools-2025.0.8.dev2.dist-info/entry_points.txt,sha256=JY7rD8p4H2_MS_4Al0KNsdB5s9uCEawa8NE4pMKlcfc,290
+cgse_tools-2025.0.8.dev2.dist-info/RECORD,,

cgse_tools-2025.0.8.dev2.dist-info/entry_points.txt

@@ -0,0 +1,11 @@
+[console_scripts]
+cgse-status = egse.tools.status:main
+
+[cgse.command.plugins]
+check = cgse_tools.cgse_commands:check[group]
+dev-x = cgse_tools.cgse_services:dev_x[group]
+show = cgse_tools.cgse_commands:show[group]
+top = cgse_tools.cgse_commands:top
+
+[cgse.version]
+cgse-tools = egse.tools

cgse_tools-2025.0.7.dist-info/RECORD

@@ -1,5 +0,0 @@
-egse/tools/status.py,sha256=2PFjU760X-E2aeLI5sWOZJ_rqHWCG6YwjmqreYpJ6_c,2188
-cgse_tools-2025.0.7.dist-info/METADATA,sha256=Rw270gskIlSkTbB-arsBIvdUcjtOrncVYpJ3OHH1gdU,608
-cgse_tools-2025.0.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cgse_tools-2025.0.7.dist-info/entry_points.txt,sha256=aRWmsZlFmI7l8gzByyUwcVTvxVYce-QxUkegSfB1yvo,205
-cgse_tools-2025.0.7.dist-info/RECORD,,

cgse_tools-2025.0.7.dist-info/entry_points.txt

@@ -1,11 +0,0 @@
-[console_scripts]
-cgse-status = egse.tools.status:main
-
-[cgse.plugins]
-foo = scripts.cgse_plugins:foo
-
-[cgse.service.plugins]
-xxx = scripts.cgse_service_plugins:xxx
-
-[cgse.version]
-cgse-tools = egse.tools