euporie 2.8.0__py3-none-any.whl → 2.8.5__py3-none-any.whl

euporie/hub/app.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 import logging
 from asyncio import get_event_loop
-from importlib.metadata import entry_points
 from typing import TYPE_CHECKING
 
 try:
@@ -18,16 +17,31 @@ except ModuleNotFoundError as err:
 from prompt_toolkit.contrib.ssh import PromptToolkitSSHSession
 from upath import UPath
 
-from euporie.core.app import BaseApp
+from euporie.core.__main__ import available_apps
+from euporie.core.app import APP_ALIASES
+from euporie.core.app.base import ConfigurableApp
 from euporie.core.config import add_setting
-from euporie.core.log import setup_logs
 
 if TYPE_CHECKING:
-    from typing import Awaitable
+    from collections.abc import Awaitable
+    from typing import Any, ClassVar
+
+    from euporie.core.app.app import BaseApp
 
 log = logging.getLogger(__name__)
 
 
+def _euporie_hub_app_choices() -> list[str]:
+    """List known euporie-apps and their aliases."""
+    from euporie.core.__main__ import available_apps
+    from euporie.core.app import APP_ALIASES
+
+    return sorted(
+        {entry.name for entry in available_apps().values()} - {"launch", "hub"}
+        | APP_ALIASES.keys()
+    )
+
+
 class EuporieSSHServer(asyncssh.SSHServer):  # type: ignore
     """Launch euporie hub, which serves a euporie app over SSH.
 
@@ -53,7 +67,7 @@ class EuporieSSHServer(asyncssh.SSHServer):  # type: ignore
         return PromptToolkitSSHSession(self.app_cls.interact, enable_cpr=True)  # type: ignore [call-arg]
 
 
-class HubApp(BaseApp):
+class HubApp(ConfigurableApp):
     """Hub App.
 
     An app which runs as a multi-user SSH server.
@@ -62,25 +76,21 @@ class HubApp(BaseApp):
     """
 
     name = "hub"
-
-    @classmethod
-    def launch(cls) -> None:
-        """Launch the HubApp SSH server."""
-        # Default logging configuration
-        setup_logs()
-
-        # Configure some setting defaults
-        cls.config.settings["log_file"].value = "-"
-        cls.config.settings["log_level"].value = "info"
-        cls.config.settings["log_config"].value = """
+    _config_defaults: ClassVar[dict[str, Any]] = {
+        "log_level_stdout": "info",
+        "log_config": """
 {
     "handlers": { "stdout": {"share_stream": false} },
     "loggers": { "asyncssh": { "handlers":["stdout"], "level": "DEBUG" } }
 }
-        """
+        """,
+    }
 
-        # Load the app's configuration
-        cls.config.load(cls)
+    @classmethod
+    def launch(cls) -> None:
+        """Launch the HubApp SSH server."""
+        # Configure some setting defaults
+        super().launch()
 
         if not cls.config.auth:
             log.warning(
@@ -88,13 +98,16 @@ class HubApp(BaseApp):
                 "meaning anyone can connect"
             )
 
+        # Detect selected app
+        chosen_app = cls.config.hub_app
+        chosen_app = APP_ALIASES.get(chosen_app, chosen_app)
+
         # Import the hubbed app
-        if entry_point := {
-            entry.name: entry for entry in entry_points()["euporie.apps"]
-        }.get(cls.config.app):
-            app_cls = entry_point.load()
+        apps = available_apps()
+        if entry := apps.get(chosen_app):
+            app_cls = entry.load()
         else:
-            raise ValueError("Application `%s` not found", cls.config.app)
+            raise ModuleNotFoundError("Application `%s` not found", cls.config.app)
 
         # Run the HubApp in an SSH server
         loop = get_event_loop()
@@ -108,24 +121,28 @@ class HubApp(BaseApp):
             )
         )
         log.info("Running euporie hub on port %s", cls.config.port)
-        loop.run_forever()
+        try:
+            loop.run_forever()
+        except KeyboardInterrupt:
+            log.info("Exiting euporie hub")
 
     # ################################### Settings ####################################
 
     add_setting(
-        name="app",
-        flags=["--app"],
-        default="notebook",
+        name="hub_app",
+        group="euporie.hub.app",
+        flags=["hub_app"],
         type_=str,
-        choices=["notebook", "console"],
-        help_="App to run under euporie hub",
+        help_="The application to launch",
+        choices=_euporie_hub_app_choices,
         description="""
-            Determine which euporie app should be launched under euporie hub.
+            The name of the application to launch.
         """,
     )
 
     add_setting(
         name="host",
+        group="euporie.hub.app",
         flags=["--host"],
         type_=str,
         help_="The host address to bind to",
@@ -137,6 +154,7 @@ class HubApp(BaseApp):
 
     add_setting(
         name="port",
+        group="euporie.hub.app",
         flags=["--port"],
         type_=int,
         help_="The port for the ssh server to use",
@@ -153,6 +171,7 @@ class HubApp(BaseApp):
 
     add_setting(
         name="host_keys",
+        group="euporie.hub.app",
         flags=["--host-keys"],
         nargs="*",
         type_=UPath,
@@ -172,6 +191,7 @@ class HubApp(BaseApp):
 
     add_setting(
         name="client_keys",
+        group="euporie.hub.app",
         flags=["--client-keys"],
         nargs="*",
         type_=UPath,
@@ -192,6 +212,7 @@ class HubApp(BaseApp):
 
     add_setting(
         name="auth",
+        group="euporie.hub.app",
         flags=["--auth"],
         type_=bool,
         help_="Allow unauthenticated access to euporie hub",

euporie/notebook/_commands.py

@@ -0,0 +1,24 @@
+"""Commands for the notebook app."""
+
+from euporie.core.commands import add_cmd
+
+
+@add_cmd(aliases=["n"])
+def _new_notebook() -> None:
+    """Create a new file."""
+    from euporie.notebook.current import get_app
+    from euporie.notebook.tabs.notebook import Notebook
+
+    app = get_app()
+    app.add_tab(tab := Notebook(app, None))
+    tab.focus()
+
+
+@add_cmd()
+def _view_documentation() -> None:
+    """Open the documentation in a web-view tab."""
+    from upath import UPath
+
+    from euporie.core.app.current import get_app
+
+    get_app().open_file(UPath("https://euporie.readthedocs.io/"))

euporie/notebook/_settings.py

@@ -0,0 +1,107 @@
+"""Define settings for the notebook app."""
+
+from euporie.core.config import add_setting
+from euporie.notebook.enums import TabMode
+
+add_setting(
+    name="tab_mode",
+    group="euporie.notebook.app",
+    flags=["--tab-mode"],
+    type_=str,
+    choices=[mode.value for mode in TabMode],
+    default="stack",
+    help_="The method used to display multiple tabs",
+    description="""
+        Determines how multiple tabs are displayed when more than one tab is open.
+        * ``stack`` displays one tab at a time with a tab-bar
+        * ``tile_horizontally`` displays tabs side-by-side
+        * ``tile_vertically`` displays tabs one-atop-the-next
+    """,
+)
+
+add_setting(
+    name="always_show_tab_bar",
+    group="euporie.notebook.app",
+    flags=["--always-show-tab-bar"],
+    type_=bool,
+    help_="Always show the tab bar",
+    default=False,
+    description="""
+        When set, the tab bar will always be shown - otherwise the tab bar is only
+        shown when multiple tabs are open.
+    """,
+)
+
+add_setting(
+    name="background_pattern",
+    group="euporie.notebook.app",
+    flags=["--background-pattern", "--bg-pattern"],
+    type_=int,
+    choices=list(range(6)),
+    help_="The background pattern to use",
+    default=2,
+    schema={
+        "minimum": 0,
+        "maximum": 5,
+    },
+    description="""
+        The background pattern to use when the notebook is narrower than the
+        available width. Zero mean no pattern is used.
+    """,
+)
+
+add_setting(
+    name="background_character",
+    group="euporie.notebook.app",
+    flags=["--background-character", "--bg-char"],
+    type_=str,
+    help_="Character for background pattern",
+    default="·",
+    schema={
+        "maxLength": 1,
+    },
+    description="""
+        The character to use when drawing the background pattern.
+
+        Recommended characters include: "·", "⬤", "╳", "╱", "╲", "░", "▒", "▓", "▞", "╬"
+    """,  # ,
+)
+
+add_setting(
+    name="run_after_external_edit",
+    group="euporie.notebook.app",
+    flags=["--run-after-external-edit"],
+    type_=bool,
+    help_="Run cells after editing externally",
+    default=False,
+    description="""
+        Whether to execute a cell immediately after editing in `$EDITOR`.
+    """,
+)
+
+add_setting(
+    name="run",
+    group="euporie.notebook.app",
+    flags=["--run"],
+    type_=bool,
+    help_="Run the notebook files when loaded",
+    default=False,
+    description="""
+        If set, notebooks will be run automatically when opened, or if previewing a
+        file, the notebooks will be run before being output.
+    """,
+)
+
+add_setting(
+    name="show_top_bar",
+    group="euporie.notebook.app",
+    flags=["--show-top-bar"],
+    type_=bool,
+    title="top bar",
+    help_="Show the top bar",
+    default=True,
+    schema={"type": "boolean"},
+    description="""
+        Whether the top bar should be shown at the top of the screen.
+    """,
+)