Use github to get core meta (#51)

* use-github-to-get-core-meta

* add-requests-as-dep

* cache-core-data

* Automatic application of license header

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: Darshan808

jupyter_builder/core_path.py

@@ -3,8 +3,35 @@
 
 from pathlib import Path
 
+import requests
 
-def default_core_path() -> str:
-    import jupyterlab
 
-    return str(Path(jupyterlab.__file__).parent / "staging")
+def get_core_staging(version: str = "main") -> str:
+    """
+    Fetch and cache JupyterLab core staging metadata.
+    Returns path to the cached staging directory.
+    """
+
+    cache_root = Path.home() / ".cache" / "jupyterlab_builder" / "core"
+    staging_path = cache_root / version
+
+    package_json_path = staging_path / "package.json"
+
+    # If already cached, reuse
+    if package_json_path.exists():
+        return str(staging_path)
+
+    # Otherwise download
+    staging_path.mkdir(parents=True, exist_ok=True)
+
+    url = (
+        "https://raw.githubusercontent.com/"
+        f"jupyterlab/jupyterlab/{version}/"
+        "jupyterlab/staging/package.json"
+    )
+
+    r = requests.get(url, timeout=10)
+    r.raise_for_status()
+
+    package_json_path.write_bytes(r.content)
+    return str(staging_path)

jupyter_builder/extension_commands/build.py

@@ -6,7 +6,6 @@
 from traitlets import Bool, Unicode
 
 from jupyter_builder.base_extension_app import BaseExtensionApp
-from jupyter_builder.core_path import default_core_path
 from jupyter_builder.federated_extensions import build_labextension
 
 HERE = os.path.dirname(os.path.abspath(__file__))
@@ -22,16 +21,23 @@ class BuildLabExtensionApp(BaseExtensionApp):
     source_map = Bool(False, config=True, help="Generate source maps")
 
     core_path = Unicode(
-        default_core_path(),
+        "",
         config=True,
         help="Directory containing core application package.json file",
     )
 
+    core_version = Unicode(
+        "main",
+        config=True,
+        help="Version of JupyterLab core to use when building (ignored if core-path is set)",
+    )
+
     aliases = {  # noqa: RUF012
         "static-url": "BuildLabExtensionApp.static_url",
         "development": "BuildLabExtensionApp.development",
         "source-map": "BuildLabExtensionApp.source_map",
         "core-path": "BuildLabExtensionApp.core_path",
+        "core-version": "BuildLabExtensionApp.core_version",
     }
 
     def run_task(self):
@@ -43,6 +49,7 @@ def run_task(self):
             static_url=self.static_url or None,
             source_map=self.source_map,
             core_path=self.core_path or None,
+            core_version=self.core_version or None,
         )
 
 

jupyter_builder/extension_commands/watch.py

@@ -6,7 +6,6 @@
 from traitlets import Bool, Unicode
 
 from jupyter_builder.base_extension_app import BaseExtensionApp
-from jupyter_builder.core_path import default_core_path
 from jupyter_builder.federated_extensions import watch_labextension
 
 HERE = os.path.dirname(os.path.abspath(__file__))
@@ -20,15 +19,22 @@ class WatchLabExtensionApp(BaseExtensionApp):
     source_map = Bool(False, config=True, help="Generate source maps")
 
     core_path = Unicode(
-        default_core_path(),
+        "",
         config=True,
         help="Directory containing core application package.json file",
     )
 
+    core_version = Unicode(
+        "main",
+        config=True,
+        help="Version of JupyterLab core to use when watching (ignored if core-path is set)",
+    )
+
     aliases = {  # noqa: RUF012
         "core-path": "WatchLabExtensionApp.core_path",
         "development": "WatchLabExtensionApp.development",
         "source-map": "WatchLabExtensionApp.source_map",
+        "core-version": "WatchLabExtensionApp.core_version",
     }
 
     def run_task(self):
@@ -41,6 +47,7 @@ def run_task(self):
             development=self.development,
             source_map=self.source_map,
             core_path=self.core_path or None,
+            core_version=self.core_version or None,
         )
 
 

jupyter_builder/federated_extensions.py

@@ -33,7 +33,7 @@
     from tomli import load
 
 from .commands import _test_overlap
-from .core_path import default_core_path
+from .core_path import get_core_staging
 
 DEPRECATED_ARGUMENT = object()
 
@@ -197,10 +197,18 @@ def develop_labextension_py(  # noqa: PLR0913
 
 
 def build_labextension(  # noqa: PLR0913
-    path, logger=None, development=False, static_url=None, source_map=False, core_path=None
+    path,
+    logger=None,
+    development=False,
+    static_url=None,
+    source_map=False,
+    core_path=None,
+    core_version=None,
 ):
     """Build a labextension in the given path"""
-    core_path = default_core_path() if core_path is None else str(Path(core_path).resolve())
+    core_path = (
+        get_core_staging(core_version) if core_path is None else str(Path(core_path).resolve())
+    )
     ext_path = str(Path(path).resolve())
 
     if logger:
@@ -220,10 +228,18 @@ def build_labextension(  # noqa: PLR0913
 
 
 def watch_labextension(  # noqa: PLR0913
-    path, labextensions_path, logger=None, development=False, source_map=False, core_path=None
+    path,
+    labextensions_path,
+    logger=None,
+    development=False,
+    source_map=False,
+    core_path=None,
+    core_version=None,
 ):
     """Watch a labextension in a given path"""
-    core_path = default_core_path() if core_path is None else str(Path(core_path).resolve())
+    core_path = (
+        get_core_staging(core_version) if core_path is None else str(Path(core_path).resolve())
+    )
     ext_path = str(Path(path).resolve())
 
     if logger:

pyproject.toml

@@ -29,7 +29,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-dependencies = ["traitlets", "jupyterlab_server"]
+dependencies = ["traitlets", "requests", "jupyterlab_server"]
 dynamic = ["version"]
 
 [project.urls]