feat: Make open to spin-off UI server and to be used in CLI and notebook

skore/pyproject.toml

@@ -18,6 +18,8 @@ dependencies = [
   "scikit-learn",
   "skops",
   "uvicorn",
+  "platformdirs",
+  "psutil",
 ]
 classifiers = [
   "Intended Audience :: Science/Research",
@@ -113,12 +115,15 @@ addopts = [
   "--ignore=doc",
   "--ignore=examples",
   "--ignore=notebooks",
+  "--dist=loadscope",
 ]
 doctest_optionflags = ["ELLIPSIS", "NORMALIZE_WHITESPACE"]
 
 [tool.coverage.run]
 branch = true
 source = ["skore"]
+concurrency = ["thread", "multiprocessing"]
+parallel = true
 
 [tool.coverage.report]
 omit = ["*/externals/*", "src/*", "tests/*"]

skore/src/skore/__init__.py

@@ -5,7 +5,7 @@
 from rich.console import Console
 from rich.theme import Theme
 
-from skore.project import Project
+from skore.project import Project, open
 from skore.sklearn import (
     CrossValidationReport,
     CrossValidationReporter,
@@ -20,6 +20,7 @@
     "CrossValidationReport",
     "EstimatorReport",
     "Project",
+    "open",
     "show_versions",
     "train_test_split",
 ]

skore/src/skore/cli/cli.py

@@ -4,61 +4,67 @@
 from importlib.metadata import version
 
 from skore.cli.color_format import ColorArgumentParser
-from skore.ui.launch import launch
+from skore.project import open
+from skore.project._launch import _kill_all_servers
 
 
-def argumentparser():
-    """Argument parser for the Skore CLI."""
-    parser = ColorArgumentParser(
-        prog="skore-ui",
-        description="Launch the skore UI on a defined skore project.",
-    )
+def cli(args: list[str]):
+    """CLI for Skore."""
+    parser = ColorArgumentParser(prog="skore-ui")
 
     parser.add_argument(
-        "--version",
-        action="version",
-        version=f"%(prog)s {version('skore')}",
+        "--version", action="version", version=f"%(prog)s {version('skore')}"
     )
 
-    parser.add_argument(
-        "project_name",
-        help="the name or path of the project to be created or opened",
-    )
+    subparsers = parser.add_subparsers(dest="subcommand")
 
-    parser.add_argument(
+    # open a skore project
+    parser_open = subparsers.add_parser(
+        "open", help="Open a skore project and start the UI"
+    )
+    parser_open.add_argument(
+        "project_path",
+        nargs="?",
+        help="the name or path of the project to be opened",
+    )
+    parser_open.add_argument(
+        "--serve",
+        action=argparse.BooleanOptionalAction,
+        help=("whether to serve the project (default: %(default)s)"),
+        default=True,
+    )
+    parser_open.add_argument(
         "--port",
         type=int,
         help="the port at which to bind the UI server (default: %(default)s)",
-        default=22140,
+        default=None,
     )
-
-    parser.add_argument(
-        "--open-browser",
-        action=argparse.BooleanOptionalAction,
-        help=(
-            "whether to automatically open a browser tab showing the web UI "
-            "(default: %(default)s)"
-        ),
-        default=True,
+    parser_open.add_argument(
+        "--verbose",
+        action="store_true",
+        help="increase logging verbosity",
     )
 
-    parser.add_argument(
+    # kill all UI servers
+    parser_kill = subparsers.add_parser("kill", help="Kill all UI servers")
+    parser_kill.add_argument(
         "--verbose",
         action="store_true",
         help="increase logging verbosity",
     )
 
-    return parser
-
-
-def cli(args: list[str]):
-    """CLI for Skore."""
-    parser = argumentparser()
-    arguments = parser.parse_args(args)
+    parsed_args: argparse.Namespace = parser.parse_args(args)
 
-    launch(
-        project_name=arguments.project_name,
-        port=arguments.port,
-        open_browser=arguments.open_browser,
-        verbose=arguments.verbose,
-    )
+    if parsed_args.subcommand == "open":
+        open(
+            project_path=parsed_args.project_path,
+            if_exists="load",
+            serve=parsed_args.serve,
+            keep_alive=True,
+            port=parsed_args.port,
+            verbose=parsed_args.verbose,
+        )
+    elif parsed_args.subcommand == "kill":
+        _kill_all_servers(verbose=parsed_args.verbose)
+    else:
+        parser.print_help()

skore/src/skore/cli/color_format.py

@@ -79,7 +79,7 @@ def format_help(self):
 
         # Color the subcommands in cyan
         help_text = re.sub(
-            r"(?<=\s)(launch|create|quickstart)(?=\s+)",
+            r"(?<=\s)(create|open|kill)(?=\s+)",
             r"[cyan bold]\1[/cyan bold]",
             help_text,
         )

skore/src/skore/exceptions.py

@@ -18,3 +18,7 @@ class ProjectCreationError(Exception):
 
 class ProjectPermissionError(Exception):
     """Permissions in the directory do not allow creating a file."""
+
+
+class ProjectLoadError(Exception):
+    """Failed to load project."""

skore/src/skore/project/__init__.py

@@ -1,7 +1,9 @@
 """Alias top level function and class of the project submodule."""
 
+from ._open import open
 from .project import Project
 
 __all__ = [
+    "open",
     "Project",
 ]