exosphere-cli 0.9.9__tar.gz

exosphere_cli-0.9.9/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 Alexandre Gauthier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

exosphere_cli-0.9.9/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: exosphere-cli
+Version: 0.9.9
+Summary: A simple centralized patch reporting tool for unix systems
+Author: Alexandre Gauthier
+Author-email: Alexandre Gauthier <alex@underwares.org>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Dist: click-shell[readline]>=2.1 ; sys_platform != 'win32'
+Requires-Dist: click-shell>=2.1 ; sys_platform == 'win32'
+Requires-Dist: fabric>=3.2.2
+Requires-Dist: typer>=0.15.2
+Requires-Dist: textual>=3.2.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: textual-serve>=1.1.2
+Requires-Dist: pyreadline3>=3.5.4 ; sys_platform == 'win32'
+Requires-Python: >=3.13
+Project-URL: homepage, https://github.com/mrdaemon/exosphere
+Project-URL: issues, https://github.com/mrdaemon/exosphere/issues
+Project-URL: repository, https://github.com/mrdaemon/exosphere
+Description-Content-Type: text/markdown
+
+# Exosphere
+
+[![Exosphere Test Suite](https://github.com/mrdaemon/exosphere/actions/workflows/exosphere-test.yml/badge.svg)](https://github.com/mrdaemon/exosphere/actions/workflows/exosphere-test.yml)
+
+Exosphere is a command line and Text User Interface driven utility to query and
+get ad-hoc reports from server infrastructure.
+
+It can, so far, be used to:
+
+- Get an overview of pending package and security updates
+- Aggregate host online status and basic information
+
+It is meant to be simple and foregoes any rich features that could otherwise be
+serviced by other, better written tools.
+
+It is meant to give a high level view of your infrastructure and how it's going,
+as well as query information about state that is otherwise difficult
+to aggregate or obtain ad-hoc.
+
+Because reporting sucks, and things could be better.
+
+  > ## Pre-release Version
+  > This is a pre-release version of Exosphere
+  > It can be used but is under-documented, and still changing rapidly
+  > You may not want to use this this just yet, and wait for 1.0
+
+## Development Quick Start
+
+tl;dr, use [uv](https://docs.astral.sh/uv/getting-started/installation/)
+
+```bash
+uv sync
+uv run exosphere
+```
+
+Linting, formatting and testing can be done with poe tasks:
+
+```bash
+uv run poe format
+uv run poe check
+uv run poe test
+```
+
+For more details, and available tasks, run:
+
+```bash
+uv run poe --help
+```
+
+## UI Development Quick Start
+
+The UI is built with [Textual](https://textual.textualize.io/).
+
+A quickstart of running the UI with live editing and reloading, with debug
+console is as follows:
+
+```bash
+# Ensure you have the dev dependencies
+uv sync --dev
+# In a separate terminal, run the console
+uv run textual console
+# In another terminal, run the UI
+uv run textual run --dev -c exosphere ui start
+```
+
+Congratulations, editing any of the tcss files in the `ui/` directory will
+reflect changes immediately.
+
+Make sure you run the exosphere ui with 'exosphere ui start' otherwise the
+configuration will not be loaded correctly, and the inventory will not be
+populated.

exosphere_cli-0.9.9/README.md

@@ -0,0 +1,71 @@
+# Exosphere
+
+[![Exosphere Test Suite](https://github.com/mrdaemon/exosphere/actions/workflows/exosphere-test.yml/badge.svg)](https://github.com/mrdaemon/exosphere/actions/workflows/exosphere-test.yml)
+
+Exosphere is a command line and Text User Interface driven utility to query and
+get ad-hoc reports from server infrastructure.
+
+It can, so far, be used to:
+
+- Get an overview of pending package and security updates
+- Aggregate host online status and basic information
+
+It is meant to be simple and foregoes any rich features that could otherwise be
+serviced by other, better written tools.
+
+It is meant to give a high level view of your infrastructure and how it's going,
+as well as query information about state that is otherwise difficult
+to aggregate or obtain ad-hoc.
+
+Because reporting sucks, and things could be better.
+
+  > ## Pre-release Version
+  > This is a pre-release version of Exosphere
+  > It can be used but is under-documented, and still changing rapidly
+  > You may not want to use this this just yet, and wait for 1.0
+
+## Development Quick Start
+
+tl;dr, use [uv](https://docs.astral.sh/uv/getting-started/installation/)
+
+```bash
+uv sync
+uv run exosphere
+```
+
+Linting, formatting and testing can be done with poe tasks:
+
+```bash
+uv run poe format
+uv run poe check
+uv run poe test
+```
+
+For more details, and available tasks, run:
+
+```bash
+uv run poe --help
+```
+
+## UI Development Quick Start
+
+The UI is built with [Textual](https://textual.textualize.io/).
+
+A quickstart of running the UI with live editing and reloading, with debug
+console is as follows:
+
+```bash
+# Ensure you have the dev dependencies
+uv sync --dev
+# In a separate terminal, run the console
+uv run textual console
+# In another terminal, run the UI
+uv run textual run --dev -c exosphere ui start
+```
+
+Congratulations, editing any of the tcss files in the `ui/` directory will
+reflect changes immediately.
+
+Make sure you run the exosphere ui with 'exosphere ui start' otherwise the
+configuration will not be loaded correctly, and the inventory will not be
+populated.

exosphere_cli-0.9.9/pyproject.toml

@@ -0,0 +1,87 @@
+[project]
+name = "exosphere-cli"
+version = "0.9.9"
+description = "A simple centralized patch reporting tool for unix systems"
+readme = "README.md"
+authors = [
+    { name = "Alexandre Gauthier", email = "alex@underwares.org" }
+]
+requires-python = ">=3.13"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: System :: Monitoring",
+    "Topic :: System :: Systems Administration",
+    "Topic :: Utilities",
+    "Typing :: Typed",
+]
+license = "MIT"
+license-files = [
+    "LICENSE"
+]
+
+dependencies = [
+    "click-shell[readline]>=2.1 ; sys_platform != 'win32'",
+    "click-shell>=2.1 ; sys_platform == 'win32'",
+    "fabric>=3.2.2",
+    "typer>=0.15.2",
+    "textual>=3.2.0",
+    "pyyaml>=6.0.2",
+    "textual-serve>=1.1.2",
+    "pyreadline3>=3.5.4 ; sys_platform == 'win32'",
+]
+
+[dependency-groups]
+dev = [
+    "fabric[pytest]>=3.2.2",
+    "poethepoet>=0.33.1",
+    "pyright>=1.1.400",
+    "pytest>=8.3.5",
+    "pytest-cov>=6.1.1",
+    "pytest-json-ctrf>=0.3.5",
+    "pytest-mock>=3.14.0",
+    "renku-sphinx-theme>=0.5.0",
+    "ruff>=0.11.5",
+    "sphinx>=8.2.3",
+    "sphinx-autobuild>=2024.10.3",
+    "sphinx-tabs>=3.4.7",
+    "textual-dev>=1.7.0",
+]
+
+[project.urls]
+homepage = "https://github.com/mrdaemon/exosphere"
+repository = "https://github.com/mrdaemon/exosphere"
+issues = "https://github.com/mrdaemon/exosphere/issues"
+
+[project.scripts]
+exosphere = "exosphere.main:main"
+
+[build-system]
+requires = ["uv_build>=0.7.19,<0.8.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "exosphere"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.poe.tasks]
+lint = "ruff check src tests"
+isort = "ruff check --select I --fix src tests"
+isort-check = "ruff check --select I src tests --diff"
+typecheck = "pyright src tests"
+ruff-format = "ruff format src tests"
+ruff-format-check = "ruff format --check src tests --diff"
+format = ['ruff-format', 'isort']
+format-check = ['ruff-format-check', 'isort-check']
+check = ['format-check', 'lint', 'typecheck']
+test = "pytest -v --ctrf .tests_report.json"
+coverage = "pytest --cov-report term-missing --cov-report html --cov=src tests/"
+docs = "sphinx-build -b html docs/source docs/build/html" 
+livedocs = "sphinx-autobuild -b html docs/source docs/build/html --port 8000 --open-browser"

exosphere_cli-0.9.9/src/exosphere/__init__.py

@@ -0,0 +1,14 @@
+import importlib.metadata
+
+from .config import Configuration
+
+# Global Instances: configuration and GlobalState
+# These are set at runtime and should be used as singletons
+# to hold the global state and configuration.
+
+app_config = Configuration()  # Has default values out of the box
+
+# Current software version, imported from pyproject metadata
+__version__ = importlib.metadata.version("exosphere_cli")
+
+__all__ = ["__version__", "app_config"]

exosphere_cli-0.9.9/src/exosphere/cli.py

@@ -0,0 +1,129 @@
+import logging
+import sys
+from typing import Annotated
+
+# ------------------win32 readline monkeypatch---------------------
+if sys.platform == "win32":
+    try:
+        # On windows, we use a wrapper module for pyreadline3 in order
+        # to provide readline compatibility.
+        from exosphere.compat import win32readline as readline
+
+        # This needs monkeypatched in order for click_shell to make use
+        # of it instead of its internal, broken, legacy pyreadline.
+        sys.modules["readline"] = readline
+    except ImportError:
+        sys.stderr.write(
+            "Warning: pyreadline3 not found. "
+            "Interactive shell may not enable all features.\n"
+        )
+# -----------------------------------------------------------------
+
+from click_shell import make_click_shell
+from rich import print
+from rich.panel import Panel
+from typer import Argument, Context, Exit, Typer
+
+from exosphere import __version__
+from exosphere.commands import config, host, inventory, ui
+
+banner = f"""[turquoise4]
+                         ▗▖
+                         ▐▌
+ ▟█▙ ▝█ █▘ ▟█▙ ▗▟██▖▐▙█▙ ▐▙██▖ ▟█▙  █▟█▌ ▟█▙
+▐▙▄▟▌ ▐█▌ ▐▛ ▜▌▐▙▄▖▘▐▛ ▜▌▐▛ ▐▌▐▙▄▟▌ █▘  ▐▙▄▟▌
+▐▛▀▀▘ ▗█▖ ▐▌ ▐▌ ▀▀█▖▐▌ ▐▌▐▌ ▐▌▐▛▀▀▘ █   ▐▛▀▀▘
+▝█▄▄▌ ▟▀▙ ▝█▄█▘▐▄▄▟▌▐█▄█▘▐▌ ▐▌▝█▄▄▌ █   ▝█▄▄▌
+ ▝▀▀ ▝▀ ▀▘ ▝▀▘  ▀▀▀ ▐▌▀▘ ▝▘ ▝▘ ▝▀▀  ▀    ▝▀▀
+                    ▐▌ [green]v{__version__}[/green][/turquoise4]
+"""
+
+app = Typer(
+    no_args_is_help=False,
+)
+
+# Setup commands from modules
+app.add_typer(inventory.app, name="inventory")
+app.add_typer(host.app, name="host")
+app.add_typer(ui.app, name="ui")
+app.add_typer(config.app, name="config")
+
+
+@app.command(hidden=True)
+def help(ctx: Context, command: Annotated[str | None, Argument()] = None):
+    """
+    Help for interactive REPL use
+
+    Provides help for the root REPL command when used interactively,
+    in a way that is friendler for that specific context.
+    If a command is specified, it will show help for that command.
+
+    This only applies when in the interactive REPL, commands (including
+    the root 'exosphere' program) will use the standard Typer help
+    system when invoked from the command line or non-interactively.
+    """
+
+    msg = "\nUse '<command> --help' or 'help <command>' for help on a specific command."
+
+    # Show root help if no command is specified
+    if not command:
+        if ctx.parent and getattr(ctx.parent, "command", None):
+            subcommands = getattr(ctx.parent.command, "commands", {})
+            lines = []
+            for name, cmd in subcommands.items():
+                if cmd.hidden:
+                    continue
+                lines.append(
+                    f"[cyan]{name:<11}[/cyan] {cmd.help or 'No description available.'}"
+                )
+            content = "\n".join(lines)
+            panel = Panel.fit(
+                content,
+                title="Commands",
+                title_align="left",
+            )
+            print("\nAvailable modules during interactive use:\n")
+            print(panel)
+        print(msg)
+        return
+
+    # Show command help if one is specified
+    subcommand = None
+    if ctx.parent and getattr(ctx.parent, "command", None):
+        subcommands = getattr(ctx.parent.command, "commands", None)
+        subcommand = subcommands.get(command) if subcommands else None
+        if subcommand:
+            subcommand.get_help(ctx)
+            print(f"\nUse '{str(subcommand.name)} <command> --help' for more details.")
+            return
+
+    # Fall through for unknown commands
+    print(f"[red]Unkown command '{command}'[/red]")
+    print(msg)
+
+
+@app.callback(invoke_without_command=True)
+def cli(ctx: Context) -> None:
+    """
+    Exosphere CLI
+
+    The main command-line interface for Exosphere.
+    It provides a REPL interface for interactive use as a prompt, but can
+    also be used to run commands directly from the command line.
+
+    Run without arguments to start the interactive mode.
+    """
+    if ctx.invoked_subcommand is None:
+        logger = logging.getLogger(__name__)
+        logger.info("Starting Exosphere REPL interface")
+
+        # Print the banner
+        print(banner)
+
+        # Start interactive REPL
+        repl = make_click_shell(
+            ctx,
+            prompt="exosphere> ",
+        )
+        repl.cmdloop()
+        Exit(0)

exosphere_cli-0.9.9/src/exosphere/commands/config.py

@@ -0,0 +1,163 @@
+import os
+from typing import Annotated
+
+import typer
+from rich.console import Console
+from rich.pretty import Pretty
+from rich.text import Text
+
+from exosphere import app_config, context
+from exosphere.config import Configuration
+
+app = typer.Typer(
+    help="Runtime Configuration Commands",
+    no_args_is_help=True,
+)
+
+console = Console()
+err_console = Console(stderr=True)
+
+
+@app.command()
+def show(
+    option: Annotated[
+        str | None,
+        typer.Argument(help="Name of the option to show. All if not specified."),
+    ] = None,
+    full: Annotated[
+        bool,
+        typer.Option(
+            "--full",
+            "-f",
+            help="Show full configuration structure, including inventory.",
+        ),
+    ] = False,
+) -> None:
+    """
+    Show the current configuration.
+
+    Displays the current configuration options, or the value of a specific option
+    if specified.
+
+    If `--full` is specified, it will show the entire configuration structure,
+    including the inventory, beyond just the "options" section.
+    """
+
+    if full:
+        if option:
+            err_console.print(
+                "[yellow]Full configuration requested, ignoring option name.[/yellow]"
+            )
+        console.print(Pretty(app_config, expand_all=True, max_depth=None))
+        return
+
+    if option:
+        if option in app_config["options"]:
+            console.print(app_config["options"][option])
+        else:
+            err_console.print(
+                f"[red]Option '{option}' not found in configuration.[/red]"
+            )
+
+        return
+
+    console.print(Pretty(app_config["options"], expand_all=True))
+
+
+@app.command()
+def source(
+    env: Annotated[
+        bool,
+        typer.Option(
+            help="Show environment variables that affect the configuration.",
+        ),
+    ] = True,
+) -> None:
+    """
+    Show the configuration source, where it was loaded from.
+
+    Displays the path of the configuration file loaded, if any, and
+    any environment variables that affect the configuration.
+    """
+
+    if context.confpath:
+        console.print(f"{context.confpath}")
+    else:
+        err_console.print("No configuration loaded, using defaults.")
+
+    if not env:
+        return
+
+    env_lines: list[str] = []
+
+    prefix = "EXOSPHERE_OPTIONS_"
+
+    for key, value in os.environ.items():
+        if (
+            key.startswith(prefix)
+            and key.removeprefix(prefix).lower() in app_config["options"]
+        ):
+            env_lines.append(f"{key}={value}")
+
+    if env_lines:
+        console.print()
+        console.print("Environment variable overrides:\n")
+        for line in env_lines:
+            console.print(f"  {line}")
+        console.print()
+
+
+@app.command()
+def diff(
+    full: Annotated[
+        bool,
+        typer.Option(
+            "--full",
+            "-f",
+            help="Show full configuration diff, including unmodified options.",
+        ),
+    ] = False,
+):
+    """
+    Show the differences between the current configuration and the defaults.
+
+    Exosphere follows convention over configuration, so your configuration
+    file can exclusively contain the options you want to change.
+
+    This command allows you to see exactly what has been changed, optionally
+    in its context, using the `--full` option.
+
+    For a full config dump, use the `show` command instead.
+    """
+
+    default_config = Configuration.DEFAULTS["options"]
+    current_config = app_config["options"]
+
+    for key in set(default_config) | set(current_config):
+        if default_config.get(key, None) != current_config.get(key, None):
+            break
+    else:
+        console.print("No differences found between current and default configuration.")
+        return
+
+    lines = []
+    for key in sorted(set(default_config) | set(current_config)):
+        default_value = default_config.get(key, None)
+        current_value = current_config.get(key, None)
+
+        line: Text | None
+
+        if default_value != current_value:
+            line = Text(f"{key!r}: {current_value!r},", style="bold green")
+            line.append(f"  # default: {default_value!r}", style="yellow")
+        else:
+            line = Text(f"{key!r}: {current_value!r},", style="dim") if full else None
+
+        if line:
+            lines.append(line)
+
+    console.print("{")
+    for line in lines:
+        console.print("    ", end="")
+        console.print(line)
+    console.print("}")