[REG]: Build static site

changelog.d/3.added.md

@@ -0,0 +1 @@
+Introduce feature files addition to registry

julio/__init__.pyi

@@ -1,5 +1,6 @@
 __all__ = [
+    "add",
     "create",
 ]
 
-from ._functions import create
+from ._functions import add, create

julio/_cli.py

@@ -7,12 +7,14 @@
 import logging.config
 import pathlib
 import sys
+from pathlib import Path
 
 import click
 import datalad
 import structlog
 
 from . import _functions as cli_func
+from . import _utils as cli_utils
 
 
 __all__ = ["cli", "create"]
@@ -152,3 +154,93 @@ def create(
         click.echo(f"{err}", err=True)
     else:
         click.echo("Success")
+
+
+@cli.command
+@click.argument(
+    "yaml_path",
+    type=click.Path(
+        exists=True,
+        readable=True,
+        writable=True,
+        dir_okay=False,
+        path_type=pathlib.Path,
+    ),
+    metavar="<yaml>",
+)
+@click.option(
+    "-r",
+    "--registry",
+    default=None,
+    type=cli_utils.PathOrURL,
+    metavar="<registry>",
+    help="Path to registry; if not passed, use current directory",
+)
+@click.option(
+    "-d",
+    "--dataset-display-name",
+    default=None,
+    type=str,
+    metavar="<dataset-display-name>",
+    help="Dataset display name; if not passed, will use the name from YAML",
+)
+@click.option("-v", "--verbose", count=True, type=int)
+def add(
+    yaml_path: click.Path,
+    registry: click.Path,
+    dataset_display_name: str,
+    verbose: int,
+) -> None:
+    """Add feature(s) registry."""
+    _set_log_config(verbose)
+    try:
+        cli_func.add(
+            yaml_path=yaml_path,
+            registry_path=registry if registry is not None else Path("."),
+            dataset_display_name=dataset_display_name,
+        )
+    except RuntimeError as err:
+        click.echo(f"{err}", err=True)
+    else:
+        click.echo("Success")
+
+
+@cli.command
+@click.option(
+    "-o",
+    "--output",
+    default=None,
+    type=click.Path(
+        readable=True,
+        writable=True,
+        dir_okay=True,
+        path_type=pathlib.Path,
+    ),
+    metavar="<output>",
+    help="Path to output directory; if not passed, use `$PWD/build`",
+)
+@click.option(
+    "-r",
+    "--registry",
+    default=None,
+    type=cli_utils.PathOrURL,
+    metavar="<registry>",
+    help="Path to registry; if not passed, use current directory",
+)
+@click.option("-v", "--verbose", count=True, type=int)
+def build(
+    output: click.Path,
+    registry: click.Path,
+    verbose: int,
+) -> None:
+    """Build static site for feature(s) registry."""
+    _set_log_config(verbose)
+    try:
+        cli_func.build(
+            output if output is not None else Path("./build"),
+            registry if registry is not None else Path("."),
+        )
+    except RuntimeError as err:
+        click.echo(f"{err}", err=True)
+    else:
+        click.echo("Success")

julio/_functions.py

@@ -3,20 +3,24 @@
 # Authors: Synchon Mandal <s.mandal@fz-juelich.de>
 # License: AGPL
 
+import shutil
+import tempfile
 from pathlib import Path
 
 import datalad.api as dl
 import structlog
 from datalad.support.exceptions import IncompleteResultsError
 
+from ._utils import build_site, is_julio_registry, process_features
 
-__all__ = ["create"]
+
+__all__ = ["add", "create"]
 
 
 logger = structlog.get_logger()
 
 
-def create(registry_path: Path):
+def create(registry_path: Path) -> None:
     """Create a registry at `registry_path`.
 
     Parameters
@@ -46,11 +50,135 @@ def create(registry_path: Path):
             path=str(registry_path.resolve()),
         )
     # Add config file
-    conf_path = Path(ds.path) / "registry-config.yml"
-    conf_path.touch()
+    conf_path = ds.pathobj / "registry-config.yml"
+    shutil.copy(
+        src=Path(__file__).parent / "registry-config.yml",
+        dst=conf_path,
+    )
     ds.save(
         conf_path,
         message="[julio] add registry configuration",
         on_failure="stop",
         result_renderer="disabled",
     )
+
+
+def add(
+    yaml_path: Path,
+    registry_path: str | Path,
+    dataset_display_name: str | None,
+) -> None:
+    """Add feature(s) from `yaml_path` to the registry at `registry_path`.
+
+    Parameters
+    ----------
+    yaml_path : pathlib.Path
+        Path to the junifer YAML.
+    registry_path : str or pathlib.Path
+        Path to the existing julio registry.
+    dataset_display_name : str or None
+        Dataset display name.
+
+    Raises
+    ------
+    RuntimeError
+        If there is a problem cloning a remote registry or
+        if the dataset is not a julio registry.
+
+    """
+    log = logger.bind(
+        cmd="add",
+        path=registry_path if str else str(registry_path.resolve()),
+    )
+    if isinstance(registry_path, str):  # pragma: no cover
+        log.debug("Cloning remote registry")
+        with tempfile.TemporaryDirectory() as tmpdir:
+            log.debug(f"Temporary directory created at {tmpdir}")
+            # Clone the remote registry
+            try:
+                ds = dl.clone(
+                    source=registry_path,
+                    path=tmpdir,
+                    on_failure="stop",
+                    result_renderer="disabled",
+                )
+            except IncompleteResultsError as e:
+                raise RuntimeError(
+                    f"Failed to clone dataset: {e.failed}"
+                ) from e
+            else:
+                log.debug("Remote registry cloned successfully")
+            if not is_julio_registry(ds):
+                raise RuntimeError(
+                    f"Dataset at {ds.path} is not a julio registry"
+                )
+            # Add features
+            process_features(yaml_path, ds, dataset_display_name)
+            # Push changes to remote registry
+            try:
+                ds = dl.push(
+                    on_failure="stop",
+                    result_renderer="disabled",
+                )
+            except IncompleteResultsError as e:
+                raise RuntimeError(
+                    f"Failed to push dataset: {e.failed}"
+                ) from e
+            else:
+                log.debug("Pushed changes to remote registry successfully")
+    else:
+        ds = dl.Dataset(registry_path)
+        if not is_julio_registry(ds):
+            raise RuntimeError(f"Dataset at {ds.path} is not a julio registry")
+        process_features(yaml_path, ds, dataset_display_name)
+
+
+def build(output: Path, registry_path: str | Path) -> None:
+    """Build static site at `output` for registry at `registry_path`.
+
+    Parameters
+    ----------
+    output : pathlib.Path
+        Path to the output directory.
+    registry_path : str or pathlib.Path
+        Path to the existing julio registry.
+
+    Raises
+    ------
+    RuntimeError
+        If there is a problem building the static site or
+        if the dataset is not a julio registry.
+
+    """
+    log = logger.bind(
+        cmd="build",
+        path=registry_path if str else str(registry_path.resolve()),
+    )
+    if isinstance(registry_path, str):  # pragma: no cover
+        log.debug("Cloning remote registry")
+        with tempfile.TemporaryDirectory() as tmpdir:
+            log.debug(f"Temporary directory created at {tmpdir}")
+            # Clone the remote registry
+            try:
+                ds = dl.clone(
+                    source=registry_path,
+                    path=tmpdir,
+                    on_failure="stop",
+                    result_renderer="disabled",
+                )
+            except IncompleteResultsError as e:
+                raise RuntimeError(
+                    f"Failed to clone dataset: {e.failed}"
+                ) from e
+            else:
+                log.debug("Remote registry cloned successfully")
+            if not is_julio_registry(ds):
+                raise RuntimeError(
+                    f"Dataset at {ds.path} is not a julio registry"
+                )
+            build_site(output, ds)
+    else:
+        ds = dl.Dataset(registry_path)
+        if not is_julio_registry(ds):
+            raise RuntimeError(f"Dataset at {ds.path} is not a julio registry")
+        build_site(output, ds)