DX: automatically list jupyterlab requirements

.cspell.json

@@ -71,6 +71,7 @@
     "indentless",
     "ipynb",
     "jsonschema",
+    "jupyterlab",
     "linkcheck",
     "maxdepth",
     "maxsplit",

src/repoma/check_dev_files/__init__.py

@@ -16,6 +16,7 @@
     github_labels,
     github_workflows,
     gitpod,
+    jupyter,
     mypy,
     nbstripout,
     precommit,
@@ -58,6 +59,8 @@ def main(argv: Optional[Sequence[str]] = None) -> int:
             skip_tests=_to_list(args.ci_skipped_tests),
             test_extras=_to_list(args.ci_test_extras),
         )
+    if has_notebooks:
+        executor(jupyter.main)
     executor(nbstripout.main)
     executor(toml.main)  # has to run before pre-commit
     executor(prettier.main, args.no_prettierrc)

src/repoma/check_dev_files/jupyter.py

@@ -0,0 +1,26 @@
+"""Update the developer setup when using Jupyter notebooks."""
+
+from repoma.utilities.executor import Executor
+from repoma.utilities.project_info import get_supported_python_versions
+from repoma.utilities.pyproject import add_dependency
+
+
+def main() -> None:
+    _update_dev_requirements()
+
+
+def _update_dev_requirements() -> None:
+    if "3.6" in get_supported_python_versions():
+        return
+    hierarchy = ["jupyter", "dev"]
+    dependencies = [
+        "jupyterlab",
+        "jupyterlab-code-formatter",
+        "jupyterlab-lsp",
+        "jupyterlab-myst",
+        "python-lsp-server[rope]",
+    ]
+    executor = Executor()
+    for dependency in dependencies:
+        executor(add_dependency, dependency, optional_key=hierarchy)
+    executor.finalize()

src/repoma/utilities/pyproject.py

@@ -63,7 +63,8 @@ def add_dependency(  # noqa: C901, PLR0912
                 executor(
                     add_dependency, f"{this_package}[{previous}]", key, source, target
                 )
-        executor.finalize()
+        if executor.finalize() == 0:
+            return
     else:
         msg = f"Unsupported type for optional_key: {type(optional_key)}"
         raise NotImplementedError(msg)