cgse 2025.0.6__tar.gz → 2025.0.8.dev1__tar.gz

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 2025.0.6
+Version: 2025.0.8.dev1
 Summary: Generic Common-EGSE: Commanding and monitoring lab equipment
 Author-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
 License: MIT

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/docs/getting_started.md

@@ -89,3 +89,28 @@ use the '--full' flag to get a more detailed report, '--doc' for help on the var
 
     The folders that do not exist (and are not None) can be created by adding the option `--mkdir` to the above 
     command.
+
+## Check your Settings
+
+Settings contains the static configuration of your system, test setup, equipment, including the System Under Test 
+(SUT). You can test your settings with the command below. Let's first also set the `ARIEL_LOCALSETTINGS` environment 
+variables:
+
+```
+$ export ARIEL_LOCAL_SETTINGS=~/cgse/local_settings_ariel_vacuum_lab.yaml
+$ py -m egse.settings
+Settings
+├── PACKAGES
+│   └── CGSE_COMMON: Common classes, functions, decorators, etc. for the CGSE
+├── SITE
+│   ├── ID: VACUUM_LAB
+│   ├── SSH_SERVER: localhost
+│   └── SSH_PORT: 22
+└── PROCESS
+    └── METRICS_INTERVAL: 10
+Memoized locations:
+['/Users/rik/tmp/gettings-started/venv/lib/python3.9/site-packages/cgse_common/settings.yaml', 
+'/Users/rik/cgse/local_settings_ariel_vacuum_lab.yaml']
+```
+These Settings will grow when you add more packages to your installation or when you define settings yourself in the 
+local settings file.

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IVS KU Leuven"}
@@ -63,7 +63,7 @@ exclude = [
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/egse", "src/cgse-common"]
+packages = ["src/egse", "src/cgse_common"]
 
 [tool.ruff]
 line-length = 120

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-common/src/egse/services.py

@@ -25,7 +25,7 @@ LOGGER = logging.getLogger(__name__)
 
 HERE = Path(__file__).parent
 
-SERVICE_SETTINGS = Settings.load(filename=str(HERE / "services.yaml"))
+SERVICE_SETTINGS = Settings.load(location=HERE, filename="services.yaml")
 
 
 class ServiceCommand(ClientServerCommand):

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-common/src/egse/setup.py

@@ -266,7 +266,8 @@ def _get_attribute(self, name, default):
 def _parse_filename_for_setup_id(filename: str):
     """Returns the setup_id from the filename, or None when no match was found."""
 
-    match = re.search(r"SETUP_([^_]+)_(\d+)", filename)
+    # match = re.search(r"SETUP_([^_]+)_(\d+)", filename)
+    match = re.search(r"SETUP_(\w+)_([\d]{5})_([\d]{6})_([\d]{6})\.yaml", filename)
 
     # TypeError when match is None
 

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-coordinates/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-coordinates"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "Reference Frames and Coordinate Transofrmations for CGSE"
 authors = [
     {name = "Rik Huygen", email = "rik.huygen@kuleuven.be"},

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-core"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "Core services for the CGSE framework"
 authors = [
     {name = "IVS KU Leuven"}
@@ -26,6 +26,7 @@ dependencies = [
     "prometheus-client>=0.21.1",
     "pyzmq == 23.2.1",
     "rich>=13.9.4",
+    "typer>=0.15.1",
 ]
 
 [project.scripts]
@@ -34,7 +35,7 @@ sm_cs = 'egse.storage.storage_cs:cli'
 cm_cs = 'egse.confman.confman_cs:cli'
 pm_cs = 'egse.procman.procman_cs:cli'
 
-cgse = 'scripts.cgse:cli'
+cgse = 'scripts.cgse:app'
 
 [project.entry-points."cgse.version"]
 cgse-core = 'egse'

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-core/src/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()

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-core/src/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():

cgse-2025.0.8.dev1/libs/cgse-core/src/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
+    )

cgse-2025.0.8.dev1/libs/cgse-core/src/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()}[/]")

cgse-2025.0.8.dev1/libs/cgse-core/src/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
+    )

cgse-2025.0.8.dev1/libs/cgse-core/src/scripts/cgse.py

@@ -0,0 +1,98 @@
+"""
+This script is as an administration script for the CGSE. The script provides commands to start, stop, and
+get the status of the core services and any other service that is registered as a plugin.
+
+The following main commands have been implemented:
+
+$ 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 core {start,stop,status}
+
+    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.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 rich
+import typer
+from rich.console import Console
+from rich.traceback import Traceback
+
+from egse.plugin import entry_points
+from scripts import services
+
+app = typer.Typer(add_completion=True)
+app.add_typer(services.app, name="core")
+
+
+@app.command()
+def version():
+    """Prints the version of the cgse-core and other registered packages."""
+    from egse.version import get_version_installed
+
+    # if installed_version := get_version_installed("cgse-core"):
+    #     rich.print(f"CGSE-CORE installed version = [bold default]{installed_version}[/]")
+
+    for ep in sorted(entry_points("cgse.version"), key=lambda x: x.name):
+        if installed_version := get_version_installed(ep.name):
+            rich.print(f"{ep.name.upper()} installed version = [bold default]{installed_version}[/]")
+
+
+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()

cgse-2025.0.8.dev1/libs/cgse-core/src/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()

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/libs/cgse-gui/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-gui"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "GUI components for CGSE"
 authors = [
     {name = "Rik Huygen", email = "rik.huygen@kuleuven.be"},

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/projects/generic/cgse-tools/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-tools"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "Tools for CGSE"
 authors = [
     {name = "IVS KU Leuven"}
@@ -33,13 +33,13 @@ 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
+# plugins for the `cgse` command, add [group] when the command has sub-commands
 
-[project.entry-points."cgse.plugins"]
-foo = 'scripts.cgse_plugins:foo'
-
-[project.entry-points."cgse.service.plugins"]
-xxx = 'scripts.cgse_service_plugins:xxx'
+[project.entry-points."cgse.command.plugins"]
+top = 'cgse_tools.cgse_commands:top'
+show = 'cgse_tools.cgse_commands:show[group]'
+check = 'cgse_tools.cgse_commands:check[group]'
+dev-x = 'cgse_tools.cgse_services:dev_x[group]'
 
 [tool.hatch.build.targets.sdist]
 exclude = [
@@ -49,7 +49,7 @@ exclude = [
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = ["src/egse"]
+packages = ["src/egse", "src/scripts"]
 
 [tool.ruff]
 line-length = 120

cgse-2025.0.8.dev1/projects/generic/cgse-tools/src/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-2025.0.8.dev1/projects/generic/cgse-tools/src/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-2025.0.6 → cgse-2025.0.8.dev1}/projects/generic/symetrie-hexapod/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "symetrie-hexapod"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "Symetrie Hexapod implementation for CGSE"
 authors = [
     {name = "IVS KU Leuven"}

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/projects/plato/plato-fits/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plato-fits"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "FITS Persistence implementation for CGSE"
 authors = [
     {name = "IVS KU Leuven"}

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/projects/plato/plato-hdf5/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plato-hdf5"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "HDF5 Persistence sub-class for CGSE"
 authors = [
     {name = "IVS KU Leuven"}

{cgse-2025.0.6 → cgse-2025.0.8.dev1}/projects/plato/plato-spw/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "plato-spw"
-version = "2025.0.6"
+version = "2025.0.8-dev.1"
 description = "SpaceWire implementation for CGSE"
 authors = [
     {name = "IVS KU Leuven"}