jupyterhub-datamountspawner 0.1.0__tar.gz

jupyterhub_datamountspawner-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

jupyterhub_datamountspawner-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+- repo: https://github.com/asottile/reorder_python_imports
+  rev: v2.6.0
+  hooks:
+  - id: reorder-python-imports
+- repo: https://github.com/psf/black
+  rev: 23.9.1
+  hooks:
+  - id: black
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v2.4.0
+  hooks:
+  - id: end-of-file-fixer
+  - id: check-json
+  - id: check-case-conflict
+  - id: check-executables-have-shebangs

jupyterhub_datamountspawner-0.1.0/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, jsc-jupyter
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

jupyterhub_datamountspawner-0.1.0/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: jupyterhub-datamountspawner
+Version: 0.1.0
+Summary: JupyterHub Spawner for JupyterLab DataMount Extension Integration
+Author-email: Tim Kreuzer <t.kreuzer@fz-juelich.de>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, jsc-jupyter
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Keywords: data,jupyterhub,spawner,storage
+Requires-Python: >=3.9
+Requires-Dist: escapism
+Requires-Dist: jinja2
+Requires-Dist: jupyterhub>=4.0.0
+Requires-Dist: traitlets
+Requires-Dist: urllib3
+Description-Content-Type: text/markdown
+
+# jupyterhub-data-mount-kubespawner
+A JupyterHub Spawner, based on the KubeSpawner, that launches JupyterLab instances with the DataMount extension for seamless external storage integration.

jupyterhub_datamountspawner-0.1.0/README.md

@@ -0,0 +1,2 @@
+# jupyterhub-data-mount-kubespawner
+A JupyterHub Spawner, based on the KubeSpawner, that launches JupyterLab instances with the DataMount extension for seamless external storage integration.

jupyterhub_datamountspawner-0.1.0/datamountspawner/__init__.py

@@ -0,0 +1,2 @@
+from ._version import __version__
+from .spawner import KubeSpawner

jupyterhub_datamountspawner-0.1.0/datamountspawner/_version.py

@@ -0,0 +1,4 @@
+# __version__ should be updated using tbump, based on configuration in
+# pyproject.toml, according to instructions in RELEASE.md.
+#
+__version__ = "0.1.0"

jupyterhub_datamountspawner-0.1.0/datamountspawner/spawner.py

@@ -0,0 +1,300 @@
+import base64
+import json
+
+from kubespawner import KubeSpawner as OrigKubeSpawner
+from traitlets import Callable
+from traitlets import default
+from traitlets import List
+from traitlets import observe
+from traitlets import Unicode
+from traitlets import Union
+
+
+class DataMountKubeSpawner(OrigKubeSpawner):
+    templates = Union(
+        trait_types=[List(), Callable()],
+        default_value=[],
+        config=True,
+        help="""
+    Configure which mount templates should be shown to the user. This also defines the order.
+    """,
+    )
+
+    def get_templates(self):
+        if callable(self.templates):
+            return self.templates(self)
+        return self.templates
+
+    init_mounts = List(
+        [],
+        help="""
+      List of dictionaries representing additional mounts to be added to the pod. 
+      
+      This may be a coroutine.
+
+      Example::
+      
+        c.KubeSpawner.init_mounts = [
+        {
+          "path": "aws",
+          "options": {
+          "displayName": "AWS #1",
+          "template": "aws",
+          "config": {
+            "remotepath": "bucketname",
+            "type": "s3",
+            "provider": "AWS",
+            "access_key_id": "_id_",
+            "secret_access_key": "_secret_",
+            "region": "eu-north-1"
+          }
+          }
+        },
+        {
+          "path": "b2drop",
+          "options": {
+          "displayName": "B2Drop",
+          "template": "b2drop",
+          "readonly": true,
+          "config": {
+            "remotepath": "/",
+            "type": "webdav",
+            "url": "https://b2drop.eudat.eu/remote.php/webdav/",
+            "vendor": "nextcloud",
+            "user": "_user_",
+            "obscure_pass": "_password_"
+          }
+          }
+        }
+        ]
+    """,
+    ).tag(config=True)
+
+    def get_env(self):
+        env = super().get_env()
+        env["JUPYTERLAB_DATA_MOUNT_ENABLED"] = "true"
+        env["JUPYTERLAB_DATA_MOUNT_DIR"] = self.data_mount_path
+        templates = self.get_templates()
+        self.log.info("ABC")
+        self.log.info(templates)
+        if templates:
+            env["JUPYTERLAB_DATA_MOUNT_TEMPLATES"] = ",".join(templates)
+        return env
+
+    def get_default_volumes(self):
+        ret = [
+            {"name": "data-mounts", "emptyDir": {}},
+            {"name": "init-mounts", "emptyDir": {}},
+        ]
+        return ret
+
+    @default("volumes")
+    def _default_volumes(self):
+        """Provide default volumes when none are set."""
+        return self.get_default_volumes()
+
+    @observe("volumes")
+    def _ensure_default_volumes(self, change):
+        new_volumes = change["new"]
+
+        try:
+            if isinstance(new_volumes, dict):
+                new_volumes = [new_volumes]
+
+            default_volumes = self.get_default_volumes()
+            if default_volumes and default_volumes not in new_volumes:
+                new_volumes.extend(default_volumes)
+
+            self.log.info(f"volumes: {new_volumes}")
+            self.volumes = new_volumes
+        except:
+            self.log.exception("wtf")
+
+    data_mount_path = Unicode(
+        "/home/jovyan/data_mounts",
+        config=True,
+        help="Path to mount data in the notebook container",
+    )
+
+    def get_default_volume_mounts(self):
+        return {
+            "name": "data-mounts",
+            "mountPath": self.data_mount_path,
+            "mountPropagation": "HostToContainer",
+        }
+
+    @default("volume_mounts")
+    def _default_volumes_mounts(self):
+        """Provide default volumes when none are set."""
+        return [self.get_default_volume_mounts()]
+
+    @observe("volume_mounts")
+    def _ensure_default_volume_mounts(self, change):
+        new_volume_mounts = change["new"]
+
+        if isinstance(new_volume_mounts, dict):
+            new_volume_mounts = [new_volume_mounts]
+
+        default_volume_mounts = self.get_default_volume_mounts()
+
+        if default_volume_mounts and default_volume_mounts not in new_volume_mounts:
+            new_volume_mounts.append(default_volume_mounts)
+
+        # self.log.info(f"volume_mounts: {new_volume_mounts}")
+        self.volume_mounts = new_volume_mounts
+
+    data_mounts_image = Unicode(
+        "jupyterjsc/jupyterlab-data-mount-api:v0.1.4",
+        config=True,
+        help="Image to use for the data mount container",
+    )
+
+    def _get_extra_data_mount_init_container(self):
+        if not self.init_mounts:
+            return None
+        try:
+            mounts_b64 = base64.b64encode(
+                json.dumps(self.init_mounts).encode()
+            ).decode()
+            return {
+                "image": "alpine:latest",
+                "imagePullPolicy": "Always",
+                "name": "init-mounts",
+                "volumeMounts": [
+                    {
+                        "name": "init-mounts",
+                        "mountPath": "/mnt/init_mounts",
+                    }
+                ],
+                "command": [
+                    "sh",
+                    "-c",
+                    "apk add --no-cache coreutils && echo '%s' | base64 -d > /mnt/init_mounts/mounts.json"
+                    % mounts_b64,
+                ],
+            }
+        except Exception as e:
+            self.log.exception("wtf")
+            return None
+
+    @default("init_containers")
+    def _default_init_containers(self):
+        """Provide default volumes when none are set."""
+        ret = self._get_extra_data_mount_init_container()
+        if ret:
+            return [ret]
+        else:
+            return []
+
+    @observe("init_containers")
+    def _ensure_default_init_containers(self, change):
+        new_init_containers = change["new"]
+
+        if isinstance(new_init_containers, dict):
+            new_init_containers = [new_init_containers]
+
+        extra_data_mount_init_container = self._get_extra_data_mount_init_container()
+
+        if (
+            extra_data_mount_init_container
+            and extra_data_mount_init_container not in new_init_containers
+        ):
+            new_init_containers.append(extra_data_mount_init_container)
+
+        # self.log.info(f"init_containers: {new_init_containers}")
+        self.init_containers = new_init_containers
+
+    def _get_extra_data_mount_container(self):
+        volume_mounts = [
+            {
+                "name": "data-mounts",
+                "mountPath": "/mnt/data_mounts",
+                "mountPropagation": "Bidirectional",
+            }
+        ]
+        if self.init_mounts:
+            volume_mounts.append(
+                {
+                    "name": "init-mounts",
+                    "mountPath": "/mnt/init_mounts/mounts.json",
+                    "subPath": "mounts.json",
+                }
+            )
+
+        extra_data_mount_container = {
+            "image": self.data_mounts_image,
+            "imagePullPolicy": "Always",
+            "name": "data-mounts",
+            "volumeMounts": volume_mounts,
+            "securityContext": {
+                "capabilities": {"add": ["SYS_ADMIN", "MKNOD", "SETFCAP"]},
+                "privileged": True,
+                "allowPrivilegeEscalation": True,
+            },
+        }
+        return extra_data_mount_container
+
+    @default("extra_containers")
+    def _default_extra_containers(self):
+        """Provide default volumes when none are set."""
+        return [self._get_extra_data_mount_container()]
+
+    @observe("extra_containers")
+    def _ensure_default_extra_containers(self, change):
+        new_extra_containers = change["new"]
+
+        if isinstance(new_extra_containers, dict):
+            new_extra_containers = [new_extra_containers]
+
+        extra_data_mount_container = self._get_extra_data_mount_container()
+
+        if (
+            extra_data_mount_container
+            and extra_data_mount_container not in new_extra_containers
+        ):
+            new_extra_containers.append(extra_data_mount_container)
+
+        # self.log.info(f"extra_containers: {new_extra_containers}")
+        self.extra_containers = new_extra_containers
+
+    @default("cmd")
+    def _default_cmd(self):
+        """Set the default command if none is provided."""
+        base_cmd = [
+            "sh",
+            "-c",
+            "pip install --user jupyterlab-data-mount==0.1.5 && "
+            "if command -v start-singleuser.sh > /dev/null; then exec start-singleuser.sh; else exec jupyterhub-singleuser; fi",
+        ]
+
+        return base_cmd
+
+    _setting_default_cmd = False
+
+    @observe("cmd")
+    def _ensure_pip_first(self, change):
+        """Ensure 'pip install --user jupyterlab-data-mount' is always prepended."""
+        # Skip recursion if we are setting the default command
+        if self._setting_default_cmd:
+            return
+
+        self._setting_default_cmd = True
+        new_cmd = change["new"]
+
+        # self.log.info(f"cmd: {new_cmd}")
+        if new_cmd is None or not isinstance(new_cmd, list) or len(new_cmd) == 0:
+            # Apply default if cmd is unset or empty
+            self.cmd = self._default_cmd()
+        else:
+            # Otherwise, modify the existing command
+            self.cmd = [
+                "sh",
+                "-c",
+                f"pip install --user jupyterlab-data-mount && ({' '.join(new_cmd)})",
+            ]
+
+
+# Implementation with the same name as the original class
+# Allows for easier integration into the JupyterHub HelmChart
+class KubeSpawner(DataMountKubeSpawner):
+    pass

jupyterhub_datamountspawner-0.1.0/pyproject.toml

@@ -0,0 +1,85 @@
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["datamountspawner"]
+include = ["*.py"]
+exclude = ["test*"]
+
+[project]
+name = "jupyterhub-datamountspawner"
+description = "JupyterHub Spawner for JupyterLab DataMount Extension Integration"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {file = "LICENSE"}
+keywords = ["jupyterhub", "spawner", "storage", "data"]
+authors = [
+    {name = "Tim Kreuzer", email = "t.kreuzer@fz-juelich.de"},
+]
+
+dependencies = [
+    "escapism",
+    "jinja2",
+    "jupyterhub>=4.0.0",
+    "traitlets",
+    "urllib3",
+]
+dynamic = ["version"]
+
+[tool.black]
+target_version = [
+  "py39",
+  "py310",
+  "py311",
+]
+
+[tool.hatch.version]
+path = "datamountspawner/_version.py"
+
+[tool.isort]
+profile = "black"
+
+[tool.tbump]
+# Uncomment this if your project is hosted on GitHub:
+github_url = "https://github.com/jsc-jupyter/jupyterhub-data-mount-kubespawner"
+
+[tool.tbump.version]
+current = "1.1.1"
+regex = '''
+  (?P<major>\d+)
+  \.
+  (?P<minor>\d+)
+  \.
+  (?P<patch>\d+)
+  (?P<pre>((a|b|rc)\d+)|)
+  \.?
+  (?P<post>((post)\d+)|)
+  (?P<dev>(?<=\.)dev\d*|)
+'''
+
+[tool.tbump.git]
+message_template = "Bump to {new_version}"
+tag_template = "{new_version}"
+
+# For each file to patch, add a [[tool.tbump.file]] config
+# section containing the path of the file, relative to the
+# pyproject.toml location.
+
+#[[tool.tbump.file]]
+#src = "pyproject.toml"
+#search = 'version = "{current_version}"'
+
+[[tool.tbump.file]]
+src = "datamountspawner/_version.py"
+#version_template = '({major}, {minor}, {patch}, "{pre}", "{dev}")'
+#search = "version_info = {current_version}"
+
+#[[tool.tbump.file]]
+#src = "docs/source/_static/rest-api.yml"
+#search = "version: {current_version}"
+
+[tool.djlint]
+indent = 2
+profile = "jinja"