cgse-core 2025.0.7__py3-none-any.whl → 2025.0.8.dev1__py3-none-any.whl

{cgse_core-2025.0.7.dist-info → cgse_core-2025.0.8.dev1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse-core
-Version: 2025.0.7
+Version: 2025.0.8.dev1
 Summary: Core services for the CGSE framework
 Author: IVS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
@@ -14,6 +14,7 @@ Requires-Dist: gitpython>=3.1.44
 Requires-Dist: prometheus-client>=0.21.1
 Requires-Dist: pyzmq==23.2.1
 Requires-Dist: rich>=13.9.4
+Requires-Dist: typer>=0.15.1
 Description-Content-Type: text/markdown
 
 # The core services for the CGSE platform

{cgse_core-2025.0.7.dist-info → cgse_core-2025.0.8.dev1.dist-info}/RECORD

@@ -3,7 +3,7 @@ cgse_core/settings.yaml,sha256=XCCcRzO_U08O1lKe6hgWmn2o4iqdF1XvshHmlf9LHjw,2719
 egse/confman/__init__.py,sha256=Woeffl3sRL-r3tfEgbtCSwZBd2GnctSt0zxULeE10c8,37831
 egse/confman/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 egse/confman/confman.yaml,sha256=V3TnUHEVlrHt2VZ1HFOGgRVjq_fhWAIAg5eslKddMEs,2909
-egse/confman/confman_cs.py,sha256=Yyhj0tvG0zQEEcsWZgPCsAW3-MDKL-9nAqXkFhVkoR4,6404
+egse/confman/confman_cs.py,sha256=9vIOCphbnPf8i66BvWJJzMJynwggz0EQvZsrZ5_ZyPY,6412
 egse/logger/__init__.py,sha256=lkwftajGyfsUQe-iwi0IDU9w5rsIirdZPqAataKC3rU,8163
 egse/logger/__main__.py,sha256=RFCl0vmeNmHeXNDbziUP5sDwC014TqwJfc8xtDvZ_as,370
 egse/logger/log_cs.py,sha256=lFZe5z5U_k28L3qp3P1rQt1Ux0OxM3pLdNXIvKSiF9s,9303
@@ -14,9 +14,13 @@ egse/storage/__init__.py,sha256=m-ooUTD6_WBssSDMAYPIBgWph2YEpf6abvxghnbd49c,4001
 egse/storage/__main__.py,sha256=LI9fxlsFWmEd5LcWUB0xA8i7Yt6UHgnblB4G0aTi3pI,28
 egse/storage/persistence.py,sha256=e4kMTszUXQxqPWBfnA_3elRHaKQmXJvKri7LwXQZXdk,18246
 egse/storage/storage.yaml,sha256=zTRtRFbuMLBILsnlIphG6iWjI1Nav6tW7uOm4cUvFuk,2593
-egse/storage/storage_cs.py,sha256=Z-HnpeqF5QgRLjhEnW4jIQ6QKFdY55jK1XBUttxww_k,5447
-scripts/cgse.py,sha256=euz9Lw3Lh0X-DZct7jywTX6JQJPiBua_zIRhsERI-64,5182
-cgse_core-2025.0.7.dist-info/METADATA,sha256=Hpw7WwUCtrnG6OgRi8Zh7arYjjBqbgEWeg5-mw399lY,631
-cgse_core-2025.0.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cgse_core-2025.0.7.dist-info/entry_points.txt,sha256=ZsNj5Fzv7_a7M-kGGZCUd8g6EK8_lonvbKK-OC8MlWk,268
-cgse_core-2025.0.7.dist-info/RECORD,,
+egse/storage/storage_cs.py,sha256=6GHCFYDf7hI1N0FSp7ZoLtnKd9614YjvWMkbQVIPXb4,5314
+scripts/_start.py,sha256=kRL_qE-PbZp5UGGgRpHsj5p_i3XEYXmgTVREvVNPtNQ,1034
+scripts/_status.py,sha256=2zRse9p-aMafaa4ZfSHWU7QxynyI988hQfvpo3Z8WD8,2004
+scripts/_stop.py,sha256=G9RlgJ3OHh8QPwuScc76hK-31koID0s8pg5Xg09Wzxg,1034
+scripts/cgse.py,sha256=humjUqGl1Lc-XMcjGOcioHA3x8Ill8e2iKAEx8SxBtk,3495
+scripts/services.py,sha256=a5VXxCyKFisoAvWOHkijQR_9jJDej_ougTfFa7CVUos,1112
+cgse_core-2025.0.8.dev1.dist-info/METADATA,sha256=zEpv_uizw1hBQJO0SUfPOdk6AJFV4nfknjUWKHCKNIw,665
+cgse_core-2025.0.8.dev1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cgse_core-2025.0.8.dev1.dist-info/entry_points.txt,sha256=NBNTUjW767NSHFvRU55mjtrmNaD7cHs9cB3FEqIeGXg,268
+cgse_core-2025.0.8.dev1.dist-info/RECORD,,

{cgse_core-2025.0.7.dist-info → cgse_core-2025.0.8.dev1.dist-info}/entry_points.txt

@@ -1,5 +1,5 @@
 [console_scripts]
-cgse = scripts.cgse:cli
+cgse = scripts.cgse:app
 cm_cs = egse.confman.confman_cs:cli
 log_cs = egse.logger.log_cs:cli
 pm_cs = egse.procman.procman_cs:cli

egse/confman/confman_cs.py

@@ -153,7 +153,7 @@ def status():
     import rich
     from egse.confman import get_status
 
-    rich.print(get_status())
+    rich.print(get_status(), end='')
 
 
 @cli.command()

egse/storage/storage_cs.py

@@ -17,7 +17,6 @@ from apscheduler.schedulers.background import BackgroundScheduler
 from prometheus_client import start_http_server
 from pytz import utc
 
-from egse.bits import humanize_bytes
 from egse.control import ControlServer
 from egse.env import get_data_storage_location
 from egse.env import get_site_id
@@ -26,8 +25,6 @@ from egse.settings import Settings
 from egse.storage import StorageProtocol
 from egse.storage import StorageProxy
 from egse.storage import cycle_daily_files
-from egse.storage import is_storage_manager_active
-from egse.system import replace_environment_variable
 
 # Use explicit name here otherwise the logger will probably be called __main__
 
@@ -145,7 +142,7 @@ def status(full):
     import rich
     from egse.storage import get_status
 
-    rich.print(get_status(full=full))
+    rich.print(get_status(full=full), end='')
 
 
 def check_prerequisites():

scripts/_start.py

@@ -0,0 +1,41 @@
+import subprocess
+import sys
+from pathlib import Path
+
+import rich
+
+
+def start_log_cs():
+    rich.print("Starting the logging core service...")
+
+    out = open(Path('~/.log_cs.start.out').expanduser(), 'w')
+
+    subprocess.Popen(
+        [sys.executable, '-m', 'egse.logger.log_cs', 'start'],
+        stdout=out, stderr=out, stdin=subprocess.DEVNULL,
+        close_fds=True
+    )
+
+
+def start_sm_cs():
+    rich.print("Starting the storage manager core service...")
+
+    out = open(Path('~/.sm_cs.start.out').expanduser(), 'w')
+
+    subprocess.Popen(
+        [sys.executable, '-m', 'egse.storage.storage_cs', 'start'],
+        stdout=out, stderr=out, stdin=subprocess.DEVNULL,
+        close_fds=True
+    )
+
+
+def start_cm_cs():
+    rich.print("Starting the configuration manager core service...")
+
+    out = open(Path('~/.cm_cs.start.out').expanduser(), 'w')
+
+    subprocess.Popen(
+        [sys.executable, '-m', 'egse.confman.confman_cs', 'start'],
+        stdout=out, stderr=out, stdin=subprocess.DEVNULL,
+        close_fds=True
+    )

scripts/_status.py

@@ -0,0 +1,81 @@
+import asyncio
+# import subprocess
+import sys
+
+import rich
+
+
+async def run_all_status():
+    tasks = [
+        status_log_cs(),
+        status_sm_cs(),
+        status_cm_cs(),
+    ]
+
+    await asyncio.gather(*tasks)
+
+
+async def status_log_cs():
+
+    proc = await asyncio.create_subprocess_exec(
+        sys.executable, '-m', 'egse.logger.log_cs', 'status',
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE
+    )
+
+    stdout, stderr = await proc.communicate()
+
+    # proc = subprocess.Popen(
+    #     [sys.executable, '-m', 'egse.logger.log_cs', 'status'],
+    #     stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+    # )
+    #
+    # stdout, stderr = proc.communicate()
+
+    rich.print(stdout.decode(), end='')
+    if stderr:
+        rich.print(f"[red]{stderr.decode()}[/]")
+
+
+async def status_sm_cs():
+
+    proc = await asyncio.create_subprocess_exec(
+        sys.executable, '-m', 'egse.storage.storage_cs', 'status',
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE
+    )
+
+    stdout, stderr = await proc.communicate()
+
+    # proc = subprocess.Popen(
+    #     [sys.executable, '-m', 'egse.storage.storage_cs', 'status'],
+    #     stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+    # )
+    #
+    # stdout, stderr = proc.communicate()
+
+    rich.print(stdout.decode(), end='')
+    if stderr:
+        rich.print(f"[red]{stderr.decode()}[/]")
+
+
+async def status_cm_cs():
+
+    proc = await asyncio.create_subprocess_exec(
+        sys.executable, '-m', 'egse.confman.confman_cs', 'status',
+        stdout=asyncio.subprocess.PIPE,
+        stderr=asyncio.subprocess.PIPE
+    )
+
+    stdout, stderr = await proc.communicate()
+
+    # proc = subprocess.Popen(
+    #     [sys.executable, '-m', 'egse.confman.confman_cs', 'status'],
+    #     stdout=subprocess.PIPE, stderr=subprocess.PIPE,
+    # )
+    #
+    # stdout, stderr = proc.communicate()
+
+    rich.print(stdout.decode(), end='')
+    if stderr:
+        rich.print(f"[red]{stderr.decode()}[/]")

scripts/_stop.py

@@ -0,0 +1,41 @@
+import subprocess
+import sys
+from pathlib import Path
+
+import rich
+
+
+def stop_log_cs():
+    rich.print("Terminating the logging core service...")
+
+    out = open(Path('~/.log_cs.stop.out').expanduser(), 'w')
+
+    subprocess.Popen(
+        [sys.executable, '-m', 'egse.logger.log_cs', 'stop'],
+        stdout=out, stderr=out, stdin=subprocess.DEVNULL,
+        close_fds=True
+    )
+
+
+def stop_sm_cs():
+    rich.print("Terminating the storage manager core service...")
+
+    out = open(Path('~/.sm_cs.stop.out').expanduser(), 'w')
+
+    subprocess.Popen(
+        [sys.executable, '-m', 'egse.storage.storage_cs', 'stop'],
+        stdout=out, stderr=out, stdin=subprocess.DEVNULL,
+        close_fds=True
+    )
+
+
+def stop_cm_cs():
+    rich.print("Terminating the configuration manager core service...")
+
+    out = open(Path('~/.cm_cs.stop.out').expanduser(), 'w')
+
+    subprocess.Popen(
+        [sys.executable, '-m', 'egse.confman.confman_cs', 'stop'],
+        stdout=out, stderr=out, stdin=subprocess.DEVNULL,
+        close_fds=True
+    )

scripts/cgse.py

@@ -9,37 +9,30 @@ $ cgse version
     Prints the installed version of the cgse-core and any other package that is registered under
     the entry points group 'cgse.version'.
 
-$ cgse {start,stop} {core,service} NAME ARGS
+$ cgse core {start,stop,status}
 
-    Starts, stops the core services or any service that is registered under the entry points
-    group 'cgse.service.plugins'.
-
-$ cgse status {core,service} NAME ARGS
-
-    Prints the status of the core services or any service that is registered under the entry
-    points group 'cgse.service.plugins'.
+    Starts, stops, or prints the status of the core services.
 
 Other main commands can be added from external packages when they are provided as entry points with
-the group name 'cgse.plugins'. The entry point needs to be a Click command.
+the group name 'cgse.command.plugins'.
 
+Commands can be added as single commands or as a group containing further sub-commands. To add a group,
+the entry point shall contain 'group' in its extras.
 """
-import subprocess
 
-import click
 import rich
+import typer
+from rich.console import Console
+from rich.traceback import Traceback
 
 from egse.plugin import entry_points
-from egse.plugin import handle_click_plugins
-from egse.process import SubProcess
-
+from scripts import services
 
-@handle_click_plugins(entry_points("cgse.plugins"))
-@click.group()
-def cli():
-    pass
+app = typer.Typer(add_completion=True)
+app.add_typer(services.app, name="core")
 
 
-@cli.command()
+@app.command()
 def version():
     """Prints the version of the cgse-core and other registered packages."""
     from egse.version import get_version_installed
@@ -52,128 +45,54 @@ def version():
             rich.print(f"{ep.name.upper()} installed version = [bold default]{installed_version}[/]")
 
 
-@cli.group()
-@click.pass_context
-def start(ctx):
-    """Start the service"""
-    ctx.ensure_object(dict)
-
-    ctx.obj['action'] = 'start'
-
-
-@cli.group()
-@click.pass_context
-def stop(ctx):
-    """Stop the service"""
-    ctx.ensure_object(dict)
-
-    ctx.obj['action'] = 'stop'
-
-
-@cli.group()
-@click.pass_context
-def status(ctx):
-    """Provide the status of the service"""
-    ctx.ensure_object(dict)
-
-    ctx.obj['action'] = 'status'
-
-
-@start.command()
-@click.pass_context
-def core(ctx):
-    print(f"executing: cgse {ctx.obj['action']} core")
-    ctx.invoke(log_cs)
-    ctx.invoke(sm_cs)
-    ctx.invoke(cm_cs)
-    ctx.invoke(pm_cs)
-
-
-@handle_click_plugins(entry_points("cgse.service.plugins"))
-@start.group()
-@click.pass_context
-def service(ctx):
-    pass
-
-
-stop.add_command(core)
-stop.add_command(service)
-
-status.add_command(core)
-status.add_command(service)
-
-
-@service.command()
-@click.pass_context
-def log_cs(ctx):
-    print(f"executing: log_cs {ctx.obj['action']}")
-    if ctx.obj['action'] == 'start':
-        proc = SubProcess("log_cs", ["log_cs", "start"])
-        proc.execute()
-    elif ctx.obj['action'] == 'stop':
-        proc = SubProcess("log_cs", ["log_cs", "stop"])
-        proc.execute()
-    elif ctx.obj['action'] == 'status':
-        proc = SubProcess("log_cs", ["log_cs", "status"], stdout=subprocess.PIPE)
-        proc.execute()
-        output, _ = proc.communicate()
-        rich.print(output, end='')
-    else:
-        rich.print(f"[red]ERROR: Unknown action '{ctx.obj['action']}'[/]")
-
-
-@service.command()
-@click.pass_context
-def sm_cs(ctx):
-    print(f"executing: sm_cs {ctx.obj['action']}")
-    if ctx.obj['action'] == 'start':
-        proc = SubProcess("sm_cs", ["sm_cs", "start"])
-        proc.execute()
-    elif ctx.obj['action'] == 'stop':
-        proc = SubProcess("sm_cs", ["sm_cs", "stop"])
-        proc.execute()
-    elif ctx.obj['action'] == 'status':
-        proc = SubProcess("sm_cs", ["sm_cs", "status"], stdout=subprocess.PIPE)
-        proc.execute()
-        output, _ = proc.communicate()
-        rich.print(output, end='')
-    else:
-        rich.print(f"[red]ERROR: Unknown action '{ctx.obj['action']}'[/]")
-
-
-@service.command()
-@click.pass_context
-def cm_cs(ctx):
-    print(f"executing: cm_cs {ctx.obj['action']}")
-    if ctx.obj['action'] == 'start':
-        proc = SubProcess("cm_cs", ["cm_cs", "start"])
-        proc.execute()
-    elif ctx.obj['action'] == 'stop':
-        proc = SubProcess("cm_cs", ["cm_cs", "stop"])
-        proc.execute()
-    elif ctx.obj['action'] == 'status':
-        proc = SubProcess("cm_cs", ["cm_cs", "status"], stdout=subprocess.PIPE)
-        proc.execute()
-        output, _ = proc.communicate()
-        rich.print(output, end='')
-    else:
-        rich.print(f"[red]ERROR: Unknown action '{ctx.obj['action']}'[/]")
-
-
-@service.command()
-@click.pass_context
-def pm_cs(ctx):
-    print(f"executing: pm_cs {ctx.obj['action']}")
-    if ctx.obj['action'] == 'start':
-        proc = SubProcess("pm_cs", ["pm_cs", "start"])
-        proc.execute()
-    elif ctx.obj['action'] == 'stop':
-        proc = SubProcess("pm_cs", ["pm_cs", "stop"])
-        proc.execute()
-    elif ctx.obj['action'] == 'status':
-        proc = SubProcess("pm_cs", ["pm_cs", "status"], stdout=subprocess.PIPE)
-        proc.execute()
-        output, _ = proc.communicate()
-        rich.print(output, end='')
-    else:
-        rich.print(f"[red]ERROR: Unknown action '{ctx.obj['action']}'[/]")
+def broken_command(name: str, module: str, exc: Exception):
+    """
+    Rather than completely crash the CLI when a broken plugin is loaded, this
+    function provides a modified help message informing the user that the plugin is
+    broken and could not be loaded.  If the user executes the plugin and specifies
+    the `--traceback` option a traceback is reported showing the exception the
+    plugin loader encountered.
+    """
+    def broken_plugin(traceback: bool = False):
+        rich.print(f"[red]ERROR: Couldn't load this plugin command: {name} ⟶ reason: {exc}[/]")
+        if traceback:
+            console = Console(width=100)
+            tb = Traceback.from_exception(type(exc), exc, exc.__traceback__)
+            console.print(tb)
+
+    broken_plugin.__doc__ = f"ERROR: Couldn't load plugin '{name}' from {module}"
+    broken_plugin.__name__ = name
+    return broken_plugin
+
+
+# Load the known plugins for the `cgse` command. Plugins are added as commands to the `cgse`.
+
+for ep in entry_points("cgse.command.plugins"):
+    try:
+        if not ep.extras or 'command' in ep.extras:
+            app.command()(ep.load())
+        elif 'group' in ep.extras:
+            app.add_typer(ep.load(), name=ep.name)
+        else:
+            rich.print(f"\n[red]ERROR: don't know what to do with {ep.extras} for {ep.name}, command not added.[/]\n")
+    except Exception as exc:
+        app.command()(broken_command(ep.name, ep.module, exc))
+
+
+for ep in entry_points("cgse.service.plugins"):
+    try:
+        app.add_typer(ep.load(), name=ep.name)
+    except Exception as exc:
+        app.command()(broken_command(ep.name, ep.module, exc))
+
+
+@app.callback(no_args_is_help=True, invoke_without_command=True)
+def main():
+    """
+    The main cgse command to inspect, configure, monitor the core services
+    and device control servers.
+    """
+
+
+if __name__ == "__main__":
+    app()

scripts/services.py

@@ -0,0 +1,49 @@
+import asyncio
+
+import rich
+import typer
+
+app = typer.Typer(
+    name="core",
+    help="handle core services: start, stop, status",
+    no_args_is_help=True
+)
+
+
+@app.command(name="start")
+def start_core_services():
+    """Start the core services in the background."""
+    from scripts._start import start_log_cs, start_sm_cs, start_cm_cs
+
+    rich.print("[green]Starting the core services...[/]")
+
+    start_log_cs()
+    start_sm_cs()
+    start_cm_cs()
+
+
+@app.command(name="stop")
+def stop_core_services():
+    """Stop the core services."""
+    from scripts._stop import stop_log_cs, stop_sm_cs, stop_cm_cs
+
+    rich.print("[green]Terminating the core services...[/]")
+
+    stop_cm_cs()
+    stop_sm_cs()
+    stop_log_cs()
+
+
+@app.command(name="status")
+def status_core_services():
+    """Print the status of the core services."""
+    # from scripts._status import status_log_cs, status_sm_cs, status_cm_cs
+
+    rich.print("[green]Status of the core services...[/]")
+
+    from scripts._status import run_all_status
+    asyncio.run(run_all_status())
+
+    # status_log_cs()
+    # status_sm_cs()
+    # status_cm_cs()