jupyterlab-code-loader 0.1.0__tar.gz

jupyterlab_code_loader-0.1.0/.claude/commands/populate-repo.md

@@ -0,0 +1,36 @@
+---
+description: Populate or update a code-loader examples repository with code examples, notebooks, scripts, and snippets. Use this command to scaffold a new repo, add domains, add code items, add snippets, add translations, validate, or rebuild the registry.
+---
+
+# Populate Code-Loader Repository
+
+You are managing a Git repository that serves the JupyterLab Code Loader extension with code examples and snippets.
+
+## Skill reference
+
+Read the skill instructions at `skills/cloader-content/SKILL.md` for the full workflow guide. For the complete repository structure specification, read `skills/cloader-content/references/repo-structure.md`.
+
+## Available scripts
+
+- **Validate**: `python skills/cloader-content/scripts/validate.py <repo_root>`
+- **Build registry**: `python skills/cloader-content/scripts/build_registry.py <repo_root> [--repo-url URL]`
+
+## Task
+
+$ARGUMENTS
+
+If no arguments were provided, ask the user what they would like to do:
+
+- Scaffold a new examples repository
+- Add a new domain
+- Add code examples (notebooks, scripts) to a domain
+- Add or update snippets
+- Add translations for existing content
+- Validate the repository structure
+- Rebuild the registry index
+
+## After every content change
+
+1. Run the validation script to check for errors
+2. Rebuild `registry.json` using the build script
+3. Show a summary of what was created or modified

jupyterlab_code_loader-0.1.0/.devcontainer/Dockerfile

@@ -0,0 +1,154 @@
+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 JupyterLab 4 and hatch build tools
+RUN pip install --no-cache-dir \
+    "jupyterlab>=4.5.0,<5" \
+    "hatchling>=1.5.0" \
+    "hatch-jupyter-builder>=0.5" \
+    "hatch-nodejs-version>=0.3.2" \
+    "pyyaml>=6.0"
+
+# 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_code_loader-0.1.0/.devcontainer/README.md

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

jupyterlab_code_loader-0.1.0/.devcontainer/devcontainer.json

@@ -0,0 +1,41 @@
+{
+  "name": "Jupyterlab Extension",
+  "remoteUser": "jupyter",
+  "forwardPorts": [8888, 9999],
+  "portsAttributes": {
+    "8888": {
+      "label": "Jupyter Lab",
+      "onAutoForward": "openBrowser",
+      "protocol": "http",
+      "url": "http://localhost:8888/lab"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "openExternal": true,
+      "defaultUrl": "/lab",
+      "extensions": [
+        "ms-python.python",
+        "ms-vscode.live-server",
+        "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-code-loader",
+  "workspaceFolder": "/workspace",
+  "shutdownAction": "stopCompose",
+  "mounts": [
+    "source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh,target=/home/jupyter/.ssh,type=bind,consistency=cached"
+  ],
+  "postCreateCommand": "pip install -e '.[dev]' && jupyter labextension develop . --overwrite && jupyter server extension enable jupyterlab-code-loader && jlpm build"
+}

jupyterlab_code_loader-0.1.0/.devcontainer/docker-compose.yaml

@@ -0,0 +1,12 @@
+version: '3.7'
+
+services:
+  jupyter-code-loader:
+    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

jupyterlab_code_loader-0.1.0/.gitignore

@@ -0,0 +1,230 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+scope/
+
+# JupyterLab extension
+node_modules/
+jupyterlab-code-loader/labextension/
+*.tsbuildinfo
+*.bundle.*
+coverage/
+ui-tests/test-results/
+ui-tests/playwright-report/
+.eslintcache
+.stylelintcache
+
+.claude/*
+!.claude/commands/
+
+.yarn/
+ui-tests/.yarn/
+
+notebooks/*
+!notebooks/.keep
+.Trash*

jupyterlab_code_loader-0.1.0/.prettierignore

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

jupyterlab_code_loader-0.1.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_code_loader-0.1.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_code_loader-0.1.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_code_loader-0.1.0/.yarnrc.yml

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

jupyterlab_code_loader-0.1.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 0.1.0
+
+### Added
+
+- Full French (fr) internationalization of all UI strings — setup form, tooltips, badges, status bar, error messages.
+- Bundled i18n JSON files (en.json, fr.json) shipped with the extension as fallback when the content repository doesn't provide translations.
+- "Open" button on code example rows to copy the file to the workspace and open it.
+- Smart snippet insertion: inserts into compatible open notebook or creates a new notebook with the correct kernel. Empty active cells are populated in-place.
+- Bash snippets get a "Copy for terminal" button that formats commands as a single pasteable line with `&&` joins.
+- Bash script and snippet support (`bash` code_lang, `.sh` file type, bash/sh kernel mapping).
+- Reset button on the sidebar toolbar to clear local configuration and return to the setup form. Visibility is controlled by the `CLOADER_ALLOW_RESET` environment variable (set to `1`, `true`, or `yes` to enable).
+- `CLOADER_SUPPORTED_LOCALES` environment variable to define supported content languages as a comma-separated list (default: `en,fr`).
+- Automatic content language detection from JupyterLab's active language. Falls back to English if the current JupyterLab language is not in the supported locales list.
+- DELETE endpoint on `/api/examples/config` to reset configuration to env-var defaults.
+
+### Changed
+
+- Sidebar title changed from "Examples & snippets" to "Code & snippets".
+- Reset button is now enabled by default; set `CLOADER_ALLOW_RESET=false` to hide it.
+- Reset now also deletes the local cache directory to free disk space.
+- Removed locale selection from the setup form. Content language is now auto-detected from JupyterLab settings.
+- `supported_locales` and `allow_reset` fields are now included in the config API response.
+
+### Fixed
+
+- Corrected package name references in README and RELEASE docs (was `jupyterlab-disable-download`, now `jupyterlab-code-loader`).
+- Fixed CSS lint issues (prettier formatting, stylelint modern color notation, kebab-case keyframes).
+- Removed unused `updateStatusBar` import in widget.ts.