jupyterlab-env-sync 1.0.0__tar.gz

jupyterlab_env_sync-1.0.0/.devcontainer/Dockerfile

@@ -0,0 +1,158 @@
+FROM debian:bookworm-slim AS jupyter
+
+LABEL author=aristide
+
+SHELL [ "/bin/bash", "-c" ]
+ENV SHELL=/bin/bash
+# Replace shell with bash so we can source files
+RUN rm /bin/sh && ln -s /bin/bash /bin/sh
+
+# Set debconf to run non-interactively
+RUN echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections
+
+RUN apt-get update \
+    && DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \
+    # For frappe framework
+    git \
+    mariadb-client \
+    postgresql-client \
+    gettext-base \
+    wget \
+    # for PDF
+    libssl-dev \
+    fonts-cantarell \
+    xfonts-75dpi \
+    xfonts-base \
+    # weasyprint dependencies
+    libpango-1.0-0 \
+    libharfbuzz0b \
+    libpangoft2-1.0-0 \
+    libpangocairo-1.0-0 \
+    # to work inside the container
+    locales \
+    build-essential \
+    cron \
+    curl \
+    vim \
+    sudo \
+    iputils-ping \
+    watch \
+    tree \
+    nano \
+    less \
+    software-properties-common \
+    bash-completion \
+    # For psycopg2
+    libpq-dev \
+    # Other
+    libffi-dev \
+    liblcms2-dev \
+    libldap2-dev \
+    libmariadb-dev \
+    libsasl2-dev \
+    libtiff5-dev \
+    libwebp-dev \
+    redis-tools \
+    rlwrap \
+    tk8.6-dev \
+    ssh-client \
+    # VSCode container requirements
+    net-tools \
+    # For pyenv build dependencies
+    # https://github.com/frappe/frappe_docker/issues/840#issuecomment-1185206895
+    make \
+    # For pandas
+    libbz2-dev \
+    # For bench execute
+    libsqlite3-dev \
+    # For other dependencies
+    zlib1g-dev \
+    libreadline-dev \
+    llvm \
+    libncurses5-dev \
+    libncursesw5-dev \
+    xz-utils \
+    tk-dev \
+    liblzma-dev \
+    file \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create new user with home directory, improve docker compatibility with UID/GID 1000,
+# add user to sudo group, allow passwordless sudo, switch to that user
+# and change directory to user home directory
+RUN groupadd -g 1000 jupyter \
+    && useradd --no-log-init -r -m -u 1000 -g 1000 -G sudo jupyter \
+    && echo "jupyter ALL=(ALL) NOPASSWD: ALL" >> /etc/sudoers
+
+USER jupyter
+WORKDIR /home/jupyter
+
+# Install Python via pyenv
+ENV PYENV_ROOT=/home/jupyter/.pyenv
+ENV PATH=$PYENV_ROOT/shims:$PYENV_ROOT/bin:$PATH
+ENV PYTHON_VERSION=3.12.7
+
+# From https://github.com/pyenv/pyenv#basic-github-checkout
+RUN git clone --depth 1 https://github.com/pyenv/pyenv.git .pyenv \
+    && pyenv install $PYTHON_VERSION \
+    && PYENV_VERSION=$PYTHON_VERSION pip install --no-cache-dir virtualenv \
+    && pyenv global $PYTHON_VERSION \
+    && sed -Ei -e '/^([^#]|$)/ {a export PYENV_ROOT="/home/jupyter/.pyenv" a export PATH="$PYENV_ROOT/bin:$PATH" a ' -e ':a' -e '$!{n;ba};}' ~/.profile \
+    && echo 'eval "$(pyenv init --path)"' >>~/.profile \
+    && echo 'eval "$(pyenv init -)"' >>~/.bashrc
+
+# Clone and install bench in the local user home directory
+# For development, bench source is located in ~/.bench
+ENV PATH=/home/jupyter/.local/bin:$PATH
+
+# Install Node via nvm
+ENV NODE_VERSION=18.20.4
+ENV NVM_DIR=/home/jupyter/.nvm
+ENV PATH=${NVM_DIR}/versions/node/v${NODE_VERSION}/bin/:${PATH}
+
+RUN wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash \
+    && . ${NVM_DIR}/nvm.sh \
+    && npm install -g yarn \
+    && nvm install ${NODE_VERSION} \
+    && nvm use v${NODE_VERSION} \
+    && npm install -g yarn \
+    && nvm alias default v${NODE_VERSION} \
+    && rm -rf ${NVM_DIR}/.cache \
+    && echo 'export NVM_DIR="/home/jupyter/.nvm"' >>~/.bashrc \
+    && echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"  # This loads nvm' >> ~/.bashrc \
+    && echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"  # This loads nvm bash_completion' >> ~/.bashrc
+
+# Install mc client
+RUN mkdir -p /home/jupyter/.local/bin \
+    && curl https://dl.min.io/client/mc/release/linux-amd64/mc -o /home/jupyter/.local/bin/mc \
+    && chmod +x /home/jupyter/.local/bin/mc
+
+# Install JupyterLab 4 and hatch build tools
+RUN pip install --no-cache-dir \
+    "jupyterlab>=4.0.0,<5" \
+    "hatchling>=1.5.0" \
+    "hatch-jupyter-builder>=0.5" \
+    "hatch-nodejs-version>=0.3.2"
+
+# Install Claude Code CLI
+RUN curl -fsSL https://claude.ai/install.sh | bash
+
+EXPOSE 8888 9999
+
+ENV PATH=/home/jupyter/.pyenv/versions/$PYTHON_VERSION/bin:$PATH
+
+FROM jupyter AS jupyter-test
+
+# Print version and verify bashrc is properly sourced so that everything works
+# in the interactive shell and Dockerfile
+
+RUN node --version \
+    && npm --version \
+    && yarn --version \
+    && python --version \
+    && jupyter lab --version \
+    && claude --version
+
+RUN bash -c "node --version" \
+    && bash -c "npm --version" \
+    && bash -c "yarn --version"

jupyterlab_env_sync-1.0.0/.devcontainer/README.md

@@ -0,0 +1,5 @@
+# build image
+
+```bash
+docker build -t aristidetm/labextension-dev .
+```

jupyterlab_env_sync-1.0.0/.devcontainer/devcontainer.json

@@ -0,0 +1,46 @@
+{
+  "name": "Jupyterlab Extension",
+  "remoteUser": "jupyter",
+  "forwardPorts": [8888, 9999, 9000, 9001],
+  "portsAttributes": {
+    "8888": {
+      "label": "Jupyter Lab",
+      "onAutoForward": "openBrowser",
+      "protocol": "http",
+      "url": "http://localhost:8888/lab"
+    },
+    "9001": {
+      "label": "MinIO Console",
+      "onAutoForward": "notify"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "openExternal": true,
+      "defaultUrl": "/lab",
+      "extensions": [
+        "ms-python.python",
+        "ms-vscode.live-server",
+        "visualstudioexptteam.vscodeintellicode",
+        "esbenp.prettier-vscode"
+      ],
+      "settings": {
+        "terminal.integrated.profiles.linux": {
+          "jupyter bash": {
+            "path": "/bin/bash"
+          }
+        },
+        "terminal.integrated.defaultProfile.linux": "jupyter bash",
+        "debug.node.autoAttach": "disabled"
+      }
+    }
+  },
+  "dockerComposeFile": "./docker-compose.yaml",
+  "service": "jupyter-minio",
+  "workspaceFolder": "/workspace",
+  "shutdownAction": "stopCompose",
+  "mounts": [
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/jupyter/.ssh,type=bind,consistency=cached"
+  ],
+  "postCreateCommand": "pip install -e . && jupyter labextension develop . --overwrite && jupyter server extension enable jupyterlab-env-sync && jlpm build"
+}

jupyterlab_env_sync-1.0.0/.devcontainer/docker-compose.yaml

@@ -0,0 +1,35 @@
+version: '3.7'
+
+# Settings and configurations that are common for all containers
+services:
+  minio:
+    image: quay.io/minio/minio:RELEASE.2024-08-29T01-40-52Z
+    command: server --console-address ":9001"  /data
+    ports:
+      - 0.0.0.0:9000:9000
+      - 0.0.0.0:9001:9001
+    environment:
+      MINIO_ROOT_USER: minioadmin
+      MINIO_ROOT_PASSWORD: minioadmin
+    healthcheck:
+      test: ["CMD", "mc", "ready", "local"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
+    volumes:
+      - data:/data
+
+  jupyter-minio:
+    image: aristidetm/labextension-dev
+    volumes:
+      - ..:/workspace
+    working_dir: /workspace
+    ports:
+      - 0.0.0.0:8888:8888
+      - 0.0.0.0:9999:9999
+    command: sleep infinity
+    depends_on:
+      - minio
+
+volumes:
+  data:

jupyterlab_env_sync-1.0.0/.gitignore

@@ -0,0 +1,140 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyterlab-env-sync/labextension
+# Version file is handled by hatchling
+# jupyterlab-env-sync/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# 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/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+.venv
+.virtual_documents
+
+# 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/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+notebooks/*
+!notebooks/.keep
+.secrets
+
+# others
+.Trash*
+
+# Claude Code
+.claude/
+
+# Yarn
+.yarn/
+
+# Error logs
+errors/
+scope/

jupyterlab_env_sync-1.0.0/.prettierignore

@@ -0,0 +1,7 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+jupyterlab-env-sync
+.venv

jupyterlab_env_sync-1.0.0/.vscode/debug.env

@@ -0,0 +1,13 @@
+# set VIRTUAL_ENV to the root of your venv
+VIRTUAL_ENV="/home/jupyter/.pyenv/versions/3.11.9"
+
+# jupyter env vars
+JUPYTER_CONFIG_DIR="${VIRTUAL_ENV}/etc/jupyter"
+JUPYTER_DATA_DIR="${VIRTUAL_ENV}/share/jupyter"
+JUPYTER_PATH="${VIRTUAL_ENV}/share/jupyter"
+JUPYTER_RUNTIME_DIR="${JUPYTER_PATH}/runtime"
+
+# jupyterlab env vars
+JUPYTERLAB_DIR="${VIRTUAL_ENV}/share/jupyter/lab"
+JUPYTERLAB_SETTINGS_DIR="${JUPYTERLAB_DIR}/settings"
+JUPYTERLAB_WORKSPACES_DIR="${JUPYTERLAB_DIR}/workspaces"

jupyterlab_env_sync-1.0.0/.vscode/launch.json

@@ -0,0 +1,55 @@
+{
+  // To debug jupyterlab running in a venv or conda env:
+  //   - set up Python env in your workspace as per https://code.visualstudio.com/docs/python/environments
+  //   - add an "envFile" prop to each backend config pointing to .vscode/debug.env
+  //   - configure the .vscode/debug.env file as needed
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "jlpm watch",
+      "type": "node-terminal",
+      "request": "launch",
+      "command": "jlpm watch"
+    },
+    {
+      "name": "jlab backend",
+      "type": "python",
+      "request": "launch",
+      "args": [
+        "--notebook-dir=notebooks",
+        "--no-browser",
+        "--NotebookApp.token=''",
+        "--port=9999",
+        "--ip=0.0.0.0",
+        "--log-level=ERROR"
+      ],
+      "justMyCode": false,
+      "module": "jupyterlab.labapp",
+      "presentation": {
+        "hidden": true
+      }
+    },
+    {
+      "name": "jlab frontend",
+      "type": "chrome",
+      "request": "launch",
+      "timeout": 180000,
+      "url": "http://localhost:9999/lab",
+      // set webroot to the parent dir of your project's top level package.json
+      "webRoot": "${workspaceFolder}",
+      "presentation": {
+        "hidden": true
+      }
+    }
+  ],
+  "compounds": [
+    {
+      "name": "jlab debug",
+      "configurations": ["jlab backend", "jlab frontend"]
+    },
+    {
+      "name": "jlab debug (watch)",
+      "configurations": ["jlpm watch", "jlab backend", "jlab frontend"]
+    }
+  ]
+}

jupyterlab_env_sync-1.0.0/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "python.defaultInterpreterPath": "/home/jupyter/.pyenv/versions/3.12.7/bin/python",
+  "[python]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true
+  },
+  "files.eol": "\n"
+}

jupyterlab_env_sync-1.0.0/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

jupyterlab_env_sync-1.0.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+## 1.0.0
+
+### New Features
+
+- **IEnvSync token** — public API for consumer extensions to set, reset, and query environment variables (`setVar`, `resetVar`, `getAll`, `getByExtension`, `resetAllByExtension`)
+- **Server-side persistence** — REST API (`GET/PUT/DELETE /jupyterlab-env-sync/env`) backed by a JSON file in the Jupyter runtime directory; also mutates `os.environ` so new processes inherit values
+- **Kernel propagation** — injects env var changes into all running Python, R, and Julia kernels via silent `requestExecute`
+- **Terminal restart** — shuts down and reopens terminals when variables change, with a toast notification
+- **Startup hooks** — installs IPython, R, and Julia startup scripts so new kernels automatically load overrides
+- **Multi-extension ownership** — tracks which extension set each variable; `resetAllByExtension` only cleans up that extension's keys
+- **Spawner-aware reset** — captures the original spawner value on first override and restores it on reset
+- **Conflict resolution** — last-write-wins with a logged warning when extensions target the same key
+
+### Tests
+
+- Python unit tests for `EnvStore` (set, reset, ownership, spawner restoration)
+- Python integration tests for REST handlers via `pytest-jupyter`
+- TypeScript unit tests for kernel injection snippet generation (Python, R, Julia)
+- Playwright UI tests for REST API and kernel propagation
+
+<!-- <END NEW CHANGELOG ENTRY> -->

jupyterlab_env_sync-1.0.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Aristide Mendo'o
+All rights reserved.
+
+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.