gridworks-admin 0.1.0.dev3__tar.gz

gridworks_admin-0.1.0.dev3/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.3
+Name: gridworks-admin
+Version: 0.1.0.dev3
+Summary: Add your description here
+Author: Andrew Schweitzer
+Author-email: Andrew Schweitzer <schweitz72@gmail.com>
+Requires-Dist: gridworks-proactor>=4.1.9
+Requires-Dist: gridworks-scada-protocol
+Requires-Dist: numpy>=2.3.3
+Requires-Dist: paho-mqtt>=2.1.0
+Requires-Dist: pydantic>=2.11.9
+Requires-Dist: python-dotenv>=1.1.1
+Requires-Dist: result>=0.9.0
+Requires-Dist: rich>=14.1.0
+Requires-Dist: textual>=6.1.0
+Requires-Dist: typer>=0.17.4
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+

gridworks_admin-0.1.0.dev3/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "gridworks-admin"
+version = "0.1.0.dev3"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Andrew Schweitzer", email = "schweitz72@gmail.com" }
+]
+requires-python = ">=3.11"
+dependencies = [
+    "gridworks-proactor>=4.1.9",
+    "gridworks-scada-protocol",
+    "numpy>=2.3.3",
+    "paho-mqtt>=2.1.0",
+    "pydantic>=2.11.9",
+    "python-dotenv>=1.1.1",
+    "result>=0.9.0",
+    "rich>=14.1.0",
+    "textual>=6.1.0",
+    "typer>=0.17.4",
+]
+
+[project.scripts]
+gwa = "gwadmin:cli.app"
+
+[build-system]
+requires = ["uv_build>=0.8.8,<0.9.0"]
+build-backend = "uv_build"
+
+[tool.uv.sources]
+gridworks-scada-protocol = { path = "../gridworks-scada-protocol", editable = true }
+
+[tool.uv.build-backend]
+module-name = "gwadmin"

gridworks_admin-0.1.0.dev3/src/gwadmin/cli.py

@@ -0,0 +1,167 @@
+import logging
+from enum import StrEnum
+from pathlib import Path
+from typing import Annotated
+from typing import Optional
+
+import dotenv
+import rich
+import typer
+
+from gwadmin.tdemo.cli import app as tdemo_cli
+from gwadmin.settings import AdminClientSettings
+from gwadmin.watch.relay_app import RelaysApp, __version__
+from gwadmin.watch.watchex.watchex_app import WatchExApp
+
+app = typer.Typer(
+    no_args_is_help=True,
+    pretty_exceptions_enable=False,
+    rich_markup_mode="rich",
+    help="GridWorks Scada Admin Client, version {__version__}",
+)
+
+app.add_typer(tdemo_cli, name="demo", help="Textual demo commands.")
+
+DEFAULT_TARGET: str = "d1.isone.me.versant.keene.orange.scada"
+
+class RelayState(StrEnum):
+    open = "0"
+    closed = "1"
+
+def watch_settings(
+    target: str = "",
+    env_file: str = ".env",
+    verbose: int = 0,
+    paho_verbose: int = 0,
+    show_clock: bool = False,
+    show_footer: bool = False,
+) -> AdminClientSettings:
+    # https://github.com/koxudaxi/pydantic-pycharm-plugin/issues/1013
+    # noinspection PyArgumentList
+    settings = AdminClientSettings(
+        _env_file=dotenv.find_dotenv(env_file),
+        show_clock=show_clock,
+        show_footer=show_footer,
+    ).update_paths_name("admin")
+    if target:
+        settings.target_gnode = target
+    elif not settings.target_gnode:
+        settings.target_gnode = DEFAULT_TARGET
+    if verbose:
+        if verbose == 1:
+            verbosity = logging.INFO
+        else:
+            verbosity = logging.DEBUG
+        settings.verbosity = verbosity
+    if paho_verbose:
+        if paho_verbose == 1:
+            paho_verbosity = logging.INFO
+        else:
+            paho_verbosity = logging.DEBUG
+        settings.paho_verbosity = paho_verbosity
+    return settings
+
+@app.command()
+def watch(
+    target: str = "",
+    env_file: str = ".env",
+    verbose: Annotated[int, typer.Option("--verbose", "-v", count=True)] = 0,
+    paho_verbose: Annotated[int, typer.Option("--paho-verbose", count=True)] = 0,
+    show_clock: Annotated[
+        bool,
+        typer.Option(
+            "--show-clock",
+        ),
+    ] = False,
+    show_footer: Annotated[
+        bool,
+        typer.Option(
+            "--show-footer",
+        ),
+    ] = False,
+) -> None:
+    """Watch and set relays."""
+    settings = watch_settings(
+        target,
+        env_file,
+        verbose,
+        paho_verbose,
+        show_clock=show_clock,
+        show_footer=show_footer,
+    )
+    rich.print(settings)
+    watch_app = RelaysApp(settings=settings)
+    watch_app.run()
+
+@app.command()
+def watchex(
+    target: str = "",
+    env_file: str = ".env",
+    verbose: Annotated[
+        int,
+        typer.Option(
+            "--verbose", "-v", count=True
+        )
+    ] = 0,
+    paho_verbose: Annotated[
+        int,
+        typer.Option(
+            "--paho-verbose", count=True
+        )
+    ] = 0
+) -> None:
+    """Watch and set relays with experimental features"""
+    settings = watch_settings(target, env_file, verbose, paho_verbose)
+    rich.print(settings)
+    watch_app = WatchExApp(settings=settings)
+    watch_app.run()
+
+@app.command()
+def config(
+    target: str = "",
+    env_file: str = ".env",
+        verbose: Annotated[
+            int,
+            typer.Option(
+                "--verbose", "-v", count=True
+            )
+        ] = 0,
+        paho_verbose: Annotated[
+            int,
+            typer.Option(
+                "--paho-verbose", count=True
+            )
+        ] = 0
+) -> None:
+    """Show admin settings."""
+    settings = watch_settings(target, env_file, verbose, paho_verbose)
+    rich.print(
+        f"Env file: <{env_file}>  exists: {bool(env_file and Path(env_file).exists())}"
+    )
+    rich.print(settings)
+    missing_tls_paths_ = settings.check_tls_paths_present(raise_error=False)
+    if missing_tls_paths_:
+        rich.print(missing_tls_paths_)
+
+
+def version_callback(value: bool):
+    if value:
+        print(f"gws admin {__version__}")
+        raise typer.Exit()
+
+@app.callback()
+def _main(
+    _version: Annotated[
+        Optional[bool],
+        typer.Option(
+            "--version",
+            callback=version_callback,
+            is_eager=True,
+            help="Show version and exit."
+        ),
+    ] = None,
+) -> None: ...
+
+
+if __name__ == "__main__":
+    app()

gridworks_admin-0.1.0.dev3/src/gwadmin/settings.py

@@ -0,0 +1,31 @@
+import logging
+from typing import Optional
+from typing import Self
+
+from gwproactor import AppSettings
+from gwproactor.config import MQTTClient
+from pydantic import model_validator
+from pydantic_settings import SettingsConfigDict
+
+from gwsproto.data_classes.house_0_names import H0N
+
+MAX_ADMIN_TIMEOUT = 60 * 60 * 24
+
+class AdminClientSettings(AppSettings):
+    target_gnode: str = ""
+    default_timeout_seconds: int = int(5*60)
+    link: MQTTClient = MQTTClient()
+    verbosity: int = logging.WARN
+    paho_verbosity: Optional[int] = None
+    show_clock: bool = False
+    show_footer: bool = False
+    model_config = SettingsConfigDict(
+        env_prefix="GWADMIN_",
+        env_nested_delimiter="__",
+        extra="ignore",
+    )
+
+    @model_validator(mode="after")
+    def validate(self) -> Self:
+        self.link.update_tls_paths(self.paths.certs_dir, H0N.admin)
+        return self

gridworks_admin-0.1.0.dev3/src/gwadmin/tdemo/actions.py

@@ -0,0 +1,46 @@
+from textual.app import App, ComposeResult
+from textual.widgets import Button
+from textual.widgets import Footer
+from textual.widgets import Static
+
+TEXT = """
+[b]Set your background[/b]
+[@click=set_background('cyan')]Cyan[/]
+[@click=set_background('magenta')]Magenta[/]
+[@click=set_background('yellow')]Yellow[/]
+"""
+
+
+class ColorSwitcher(Static, can_focus=True):
+    BINDINGS = [
+        ("o", "set_background('olive')", "olive"),
+        ("w", "set_background('ansi_white')", "ansi_white"),
+        ("s", "set_background('silver')", "silver"),
+    ]
+    def action_set_background(self, color: str) -> None:
+        self.styles.background = color
+
+
+class ActionsApp(App):
+    CSS_PATH = "actions05.tcss"
+    BINDINGS = [
+        ("q", "quit"),
+        ("ctrl+c", "quit"),
+        ("r", "set_background('red')", "Red"),
+        ("g", "set_background('green')", "Green"),
+        ("b", "set_background('blue')", "Blue"),
+    ]
+
+    def compose(self) -> ComposeResult:
+        yield ColorSwitcher(TEXT)
+        yield ColorSwitcher(TEXT)
+        yield Button("foo")
+        yield Footer()
+
+    def action_set_background(self, color: str) -> None:
+        self.screen.styles.background = color
+
+
+if __name__ == "__main__":
+    app = ActionsApp()
+    app.run()

gridworks_admin-0.1.0.dev3/src/gwadmin/tdemo/actions05.tcss

@@ -0,0 +1,20 @@
+Screen {
+    layout: grid;
+    grid-size: 1;
+    grid-gutter: 2 4;
+    grid-rows: 1fr;
+}
+
+ColorSwitcher {
+   height: 100%;
+   margin: 2 4;
+   border: solid blue;
+
+    &:focus {
+        background: $primary;
+        color: $text;
+        text-style: bold;
+        outline-left: thick $accent;
+    }
+}
+

gridworks_admin-0.1.0.dev3/src/gwadmin/tdemo/cli.py

@@ -0,0 +1,39 @@
+import typer
+
+from gwadmin.tdemo.actions import ActionsApp
+from gwadmin.tdemo.stopwatch import StopwatchApp
+from gwadmin.tdemo.switch import SwitchApp
+
+app = typer.Typer(
+    no_args_is_help=True,
+    pretty_exceptions_enable=False,
+    rich_markup_mode="rich",
+    help="Textual demo apps",
+)
+
+
+@app.command()
+def stopwatch():
+    """Run textual stopwatch demo"""
+    stopwatch_app = StopwatchApp()
+    stopwatch_app.run()
+
+@app.command()
+def switch():
+    """Run textual switch demo"""
+    switch_app = SwitchApp()
+    switch_app.run()
+
+@app.command()
+def actions():
+    """Run textual actions demo"""
+    actions_app = ActionsApp()
+    actions_app.run()
+
+
+@app.callback()
+def _main() -> None: ...
+
+
+if __name__ == "__main__":
+    app()

gridworks_admin-0.1.0.dev3/src/gwadmin/tdemo/stopwatch.py

@@ -0,0 +1,109 @@
+from time import monotonic
+
+from textual.app import App, ComposeResult
+from textual.containers import HorizontalGroup, VerticalScroll
+from textual.reactive import reactive
+from textual.widgets import Button, Digits, Footer, Header
+
+
+class TimeDisplay(Digits):
+    """A widget to display elapsed time."""
+
+    start_time = reactive(monotonic)
+    time = reactive(0.0)
+    total = reactive(0.0)
+
+    def on_mount(self) -> None:
+        """Event handler called when widget is added to the app."""
+        self.update_timer = self.set_interval(1 / 60, self.update_time, pause=True)
+
+    def update_time(self) -> None:
+        """Method to update time to current."""
+        self.time = self.total + (monotonic() - self.start_time)
+
+    def watch_time(self, time: float) -> None:
+        """Called when the time attribute changes."""
+        minutes, seconds = divmod(time, 60)
+        hours, minutes = divmod(minutes, 60)
+        self.update(f"{hours:02,.0f}:{minutes:02.0f}:{seconds:05.2f}")
+
+    def start(self) -> None:
+        """Method to start (or resume) time updating."""
+        self.start_time = monotonic()
+        self.update_timer.resume()
+
+    def stop(self):
+        """Method to stop the time display updating."""
+        self.update_timer.pause()
+        self.total += monotonic() - self.start_time
+        self.time = self.total
+
+    def reset(self):
+        """Method to reset the time display to zero."""
+        self.total = 0
+        self.time = 0
+
+
+class Stopwatch(HorizontalGroup):
+    """A stopwatch widget."""
+
+    def on_button_pressed(self, event: Button.Pressed) -> None:
+        """Event handler called when a button is pressed."""
+        button_id = event.button.id
+        time_display = self.query_one(TimeDisplay)
+        if button_id == "start":
+            time_display.start()
+            self.add_class("started")
+        elif button_id == "stop":
+            time_display.stop()
+            self.remove_class("started")
+        elif button_id == "reset":
+            time_display.reset()
+
+    def compose(self) -> ComposeResult:
+        """Create child widgets of a stopwatch."""
+        yield Button("Start", id="start", variant="success")
+        yield Button("Stop", id="stop", variant="error")
+        yield Button("Reset", id="reset")
+        yield TimeDisplay()
+
+
+class StopwatchApp(App):
+    """A Textual app to manage stopwatches."""
+
+    CSS_PATH = "stopwatch.tcss"
+
+    BINDINGS = [
+        ("d", "toggle_dark", "Toggle dark mode"),
+        ("a", "add_stopwatch", "Add"),
+        ("r", "remove_stopwatch", "Remove"),
+    ]
+
+    def compose(self) -> ComposeResult:
+        """Called to add widgets to the app."""
+        yield Header()
+        yield Footer()
+        yield VerticalScroll(Stopwatch(), Stopwatch(), Stopwatch(), id="timers")
+
+    def action_add_stopwatch(self) -> None:
+        """An action to add a timer."""
+        new_stopwatch = Stopwatch()
+        self.query_one("#timers").mount(new_stopwatch)
+        new_stopwatch.scroll_visible()
+
+    def action_remove_stopwatch(self) -> None:
+        """Called to remove a timer."""
+        timers = self.query("Stopwatch")
+        if timers:
+            timers.last().remove()
+
+    def action_toggle_dark(self) -> None:
+        """An action to toggle dark mode."""
+        self.theme = (
+            "textual-dark" if self.theme == "textual-light" else "textual-light"
+        )
+
+
+if __name__ == "__main__":
+    app = StopwatchApp()
+    app.run()

gridworks_admin-0.1.0.dev3/src/gwadmin/tdemo/stopwatch.tcss

@@ -0,0 +1,51 @@
+Stopwatch {
+    background: $boost;
+    height: 5;
+    margin: 1;
+    min-width: 50;
+    padding: 1;
+}
+
+TimeDisplay {
+    text-align: center;
+    color: $foreground-muted;
+    height: 3;
+}
+
+Button {
+    width: 16;
+}
+
+#start {
+    dock: left;
+}
+
+#stop {
+    dock: left;
+    display: none;
+}
+
+#reset {
+    dock: right;
+}
+
+.started {
+    background: $success-muted;
+    color: $text;
+}
+
+.started TimeDisplay {
+    color: $foreground;
+}
+
+.started #start {
+    display: none
+}
+
+.started #stop {
+    display: block
+}
+
+.started #reset {
+    visibility: hidden
+}

gridworks_admin-0.1.0.dev3/src/gwadmin/tdemo/switch.py

@@ -0,0 +1,42 @@
+from textual.app import App, ComposeResult
+from textual.containers import Horizontal
+from textual.widgets import Static, Switch
+
+
+class SwitchApp(App):
+    CSS_PATH = "switch.tcss"
+
+    BINDINGS = [
+        ("d", "toggle_dark", "Toggle dark mode"),
+        ("q", "quit", "Quit"),
+    ]
+
+    def compose(self) -> ComposeResult:
+        yield Static("[b]Example switches\n", classes="label")
+        yield Horizontal(
+            Static("off:     ", classes="label"),
+            Switch(animate=False),
+            classes="container",
+        )
+        yield Horizontal(
+            Static("on:      ", classes="label"),
+            Switch(value=True),
+            classes="container",
+        )
+
+        focused_switch = Switch()
+        focused_switch.focus()
+        yield Horizontal(
+            Static("focused: ", classes="label"), focused_switch, classes="container"
+        )
+
+        yield Horizontal(
+            Static("custom:  ", classes="label"),
+            Switch(id="custom-design"),
+            classes="container",
+        )
+
+
+app = SwitchApp(css_path="switch.tcss")
+if __name__ == "__main__":
+    app.run()

gridworks_admin-0.1.0.dev3/src/gwadmin/tdemo/switch.tcss

@@ -0,0 +1,28 @@
+Screen {
+    align: center middle;
+}
+
+.container {
+    height: auto;
+    width: auto;
+}
+
+Switch {
+    height: auto;
+    width: auto;
+}
+
+.label {
+    height: 3;
+    content-align: center middle;
+    width: auto;
+}
+
+#custom-design {
+    background: darkslategrey;
+}
+
+#custom-design > .switch--slider {
+    color: dodgerblue;
+    background: darkslateblue;
+}