jupyterlab-mlflow 0.2.1__tar.gz

jupyterlab_mlflow-0.2.1/.eslintrc.js

@@ -0,0 +1,26 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier'
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: true
+    }
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/explicit-module-boundary-types': 'off'
+  },
+  env: {
+    browser: true,
+    node: true,
+    es6: true
+  }
+};
+

jupyterlab_mlflow-0.2.1/.github/workflows/ci.yml

@@ -0,0 +1,95 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11']
+        node-version: ['18', '20']
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install JupyterLab
+        run: |
+          python -m pip install --upgrade pip
+          pip install "jupyterlab>=4.0.0,<5"
+
+      - name: Install Node.js dependencies
+        run: |
+          npm install -g npm
+          npm ci
+
+      - name: Install Python dependencies
+        run: |
+          pip install -e .[test]
+
+      - name: Build extension
+        run: |
+          npm run clean:lib
+          npm run clean:labextension
+          npm run build:lib
+          python -m jupyter labextension build .
+
+      - name: Install build dependencies
+        run: |
+          pip install build hatchling hatch-nodejs-version
+
+      - name: Build Python package
+        run: |
+          python -m build
+
+      - name: Check package contents
+        run: |
+          pip install check-wheel-contents
+          check-wheel-contents dist/*.whl || true
+
+  version:
+    runs-on: ubuntu-latest
+    needs: test
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    permissions:
+      contents: write # Required to push version bumps and tags
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Required for semantic-release to analyze commits
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Configure Git
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release
+

jupyterlab_mlflow-0.2.1/.github/workflows/publish.yml

@@ -0,0 +1,97 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]  # Triggers on manual GitHub releases only
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install JupyterLab
+        run: |
+          python -m pip install --upgrade pip
+          pip install "jupyterlab>=4.0.0,<5"
+
+      - name: Install Node.js dependencies
+        run: |
+          npm install -g npm
+          npm ci
+
+      - name: Build extension
+        run: |
+          npm run clean:lib
+          npm run clean:labextension
+          npm run build:lib
+          python -m jupyter labextension build .
+
+      - name: Install build dependencies
+        run: |
+          pip install build hatchling hatch-nodejs-version
+
+      - name: Build Python package
+        run: |
+          python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-dist
+          path: dist/
+          retention-days: 7
+
+  publish-testpypi:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'workflow_dispatch' && (github.event.inputs.repository == 'testpypi' || github.event.inputs.repository == '') || github.event_name == 'release' && contains(github.event.release.tag_name, 'rc')
+    environment:
+      name: testpypi
+    permissions:
+      id-token: write  # Required for TestPyPI trusted publishing
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-dist
+          path: dist/
+
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'release' && !contains(github.event.release.tag_name, 'rc') || github.event_name == 'workflow_dispatch' && github.event.inputs.repository == 'pypi'
+    environment:
+      name: pypi
+    permissions:
+      id-token: write  # Required for PyPI trusted publishing
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-dist
+          path: dist/
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+

jupyterlab_mlflow-0.2.1/.gitignore

@@ -0,0 +1,67 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Jupyter
+.ipynb_checkpoints
+*.ipynb
+
+# Node
+node_modules/
+npm-debug.log
+yarn-error.log
+lerna-debug.log
+
+# TypeScript
+*.tsbuildinfo
+
+# Lab extension files
+jupyterlab_mlflow/labextension
+*.tsbuildinfo
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Environment
+.env
+.venv
+env/
+venv/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Build artifacts
+*.log
+
+# MLflow local data
+mlruns/
+

jupyterlab_mlflow-0.2.1/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "semi": true
+}
+

jupyterlab_mlflow-0.2.1/.releaserc.json

@@ -0,0 +1,21 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": ["package.json"],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ]
+  ]
+}
+

jupyterlab_mlflow-0.2.1/LICENSE

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, JupyterLab MLflow Contributors
+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.
+

jupyterlab_mlflow-0.2.1/Makefile

@@ -0,0 +1,64 @@
+# Makefile for JupyterLab MLflow Extension Development
+
+# Configuration
+PYTHON_VERSION := 3.9
+JUPYTERLAB_CORE_PATH := $(HOME)/Library/Python/$(PYTHON_VERSION)/lib/python/site-packages/jupyterlab/staging
+LABEXTENSION_PATH := $(HOME)/Library/Python/$(PYTHON_VERSION)/share/jupyter/labextensions/jupyterlab-mlflow
+SOURCE_LABEXTENSION := jupyterlab_mlflow/labextension
+
+# Colors for output
+GREEN := \033[0;32m
+YELLOW := \033[0;33m
+NC := \033[0m # No Color
+
+.PHONY: help build build-lib build-labextension install clean install-deps rebuild dev-install
+
+help: ## Show this help message
+	@echo "JupyterLab MLflow Extension - Development Makefile"
+	@echo ""
+	@echo "Available targets:"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  $(GREEN)%-20s$(NC) %s\n", $$1, $$2}'
+
+build-lib: ## Build TypeScript source files
+	@echo "$(YELLOW)Building TypeScript...$(NC)"
+	npm run build:lib
+
+build-labextension: build-lib ## Build JupyterLab extension bundle
+	@echo "$(YELLOW)Building labextension...$(NC)"
+	node node_modules/@jupyterlab/builder/lib/build-labextension.js . --core-path $(JUPYTERLAB_CORE_PATH)
+
+install: build-labextension ## Install extension to JupyterLab (removes old, copies new)
+	@echo "$(YELLOW)Installing extension...$(NC)"
+	@if [ -d "$(LABEXTENSION_PATH)" ]; then \
+		rm -rf "$(LABEXTENSION_PATH)"; \
+	fi
+	@cp -r $(SOURCE_LABEXTENSION) "$(LABEXTENSION_PATH)"
+	@echo "$(GREEN)✅ Extension installed to $(LABEXTENSION_PATH)$(NC)"
+
+rebuild: clean build-labextension install ## Clean, build, and install extension
+
+dev-install: build-labextension ## Quick install for development (assumes build already done)
+	@echo "$(YELLOW)Installing extension (dev mode)...$(NC)"
+	@if [ -d "$(LABEXTENSION_PATH)" ]; then \
+		rm -rf "$(LABEXTENSION_PATH)"; \
+	fi
+	@cp -r $(SOURCE_LABEXTENSION) "$(LABEXTENSION_PATH)"
+	@echo "$(GREEN)✅ Extension installed$(NC)"
+
+clean: ## Clean build artifacts
+	@echo "$(YELLOW)Cleaning build artifacts...$(NC)"
+	@rm -rf lib
+	@rm -rf jupyterlab_mlflow/labextension
+	@rm -rf tsconfig.tsbuildinfo
+	@echo "$(GREEN)✅ Cleaned$(NC)"
+
+install-deps: ## Install npm and Python dependencies
+	@echo "$(YELLOW)Installing dependencies...$(NC)"
+	npm install
+	@echo "$(GREEN)✅ Dependencies installed$(NC)"
+
+build: build-labextension ## Alias for build-labextension
+
+# Default target
+.DEFAULT_GOAL := help
+

jupyterlab_mlflow-0.2.1/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: jupyterlab-mlflow
+Version: 0.2.1
+Project-URL: Homepage, https://github.com/BioLM/jupyterlab-mlflow
+Project-URL: Bug Tracker, https://github.com/BioLM/jupyterlab-mlflow/issues
+Project-URL: Documentation, https://github.com/BioLM/jupyterlab-mlflow#readme
+Project-URL: Source, https://github.com/BioLM/jupyterlab-mlflow
+Author: JupyterLab MLflow Contributors
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, JupyterLab MLflow Contributors
+        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.
+        
+License-File: LICENSE
+Keywords: Jupyter,JupyterLab,MLflow,jupyterlab-extension
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8
+Requires-Dist: jupyterlab<5,>=4.0.0
+Requires-Dist: mlflow>=2.0.0
+Requires-Dist: tornado>=6.0.0
+Provides-Extra: test
+Requires-Dist: playwright; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# JupyterLab MLflow Extension
+
+A JupyterLab extension for browsing MLflow experiments, runs, models, and artifacts directly from the JupyterLab sidebar.
+
+## Features
+
+- Browse MLflow experiments, runs, models, and artifacts
+- Tree view for hierarchical navigation
+- Details/Object view for exploring metadata and child objects
+- View artifacts in new JupyterLab tabs
+- Copy experiment/run/model IDs to clipboard
+- Generate and insert MLflow Python API code snippets
+- Connect to remote MLflow tracking servers
+- Launch local MLflow server with SQLite backend
+- Settings UI with environment variable fallback
+- MLflow shortcuts panel for common operations
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+- Python >= 3.8
+- MLflow >= 2.0.0
+
+## Installation
+
+```bash
+pip install jupyterlab-mlflow
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/BioLM/jupyterlab-mlflow.git
+cd jupyterlab-mlflow
+pip install -e .
+jlpm install
+jlpm build
+```
+
+## Configuration
+
+The extension can be configured via:
+
+1. **Settings UI**: Open JupyterLab Settings → Advanced Settings Editor → MLflow
+2. **Environment Variable**: Set `MLFLOW_TRACKING_URI` environment variable
+
+### Server Extension
+
+The extension includes a server-side component that must be enabled. After installation, enable it with:
+
+```bash
+jupyter server extension enable jupyterlab_mlflow.serverextension
+```
+
+Or enable it system-wide:
+
+```bash
+jupyter server extension enable jupyterlab_mlflow.serverextension --sys-prefix
+```
+
+Verify it's enabled:
+
+```bash
+jupyter server extension list
+```
+
+You should see `jupyterlab_mlflow.serverextension` in the enabled extensions list.
+
+**Note**: In some JupyterLab deployments (especially managed environments), the server extension may need to be enabled by an administrator or configured in the deployment settings.
+
+## Usage
+
+1. Configure your MLflow tracking URI in the settings or via environment variable
+2. The MLflow sidebar will appear in the left sidebar
+3. Browse experiments, runs, models, and artifacts
+4. Click on artifacts to view them in new tabs
+5. Right-click on items to copy IDs to clipboard
+
+## Development
+
+### Quick Local Testing
+
+To test the extension locally without publishing to PyPI:
+
+```bash
+# Option 1: Use the test script (recommended)
+./test_server_extension.sh
+
+# Option 2: Manual steps
+pip install -e .
+npm run build:lib
+python -m jupyter labextension build . --dev
+jupyter server extension enable jupyterlab_mlflow.serverextension
+jupyter lab
+```
+
+### Testing API Endpoints
+
+After starting JupyterLab, test the server extension API endpoints:
+
+```bash
+# In another terminal, test the endpoints
+./test_api_endpoints.sh http://localhost:8888 http://localhost:5000
+```
+
+Or manually test with curl:
+
+```bash
+# Test connection endpoint
+curl "http://localhost:8888/mlflow/api/connection/test?tracking_uri=http://localhost:5000"
+
+# Test local server status
+curl "http://localhost:8888/mlflow/api/local-server"
+```
+
+### Development Workflow
+
+```bash
+# Install dependencies
+jlpm install
+
+# Build the extension
+jlpm build
+
+# Watch for changes
+jlpm watch
+
+# Run tests
+pytest
+```
+
+## Publishing
+
+This package uses automatic version bumping and is published to PyPI when a new release is created on GitHub.
+
+### Automatic Version Bumping
+
+Version bumping is handled automatically by `semantic-release` based on commit messages:
+
+- `feat: something` → minor version bump (0.1.0 → 0.2.0)
+- `fix: something` → patch version bump (0.1.0 → 0.1.1)
+- `BREAKING: something` → major version bump (0.1.0 → 1.0.0)
+
+When you push to `main`, semantic-release will:
+1. Analyze commits since last release
+2. Bump version in `package.json` (if needed)
+3. Create a git tag
+4. Push the tag to GitHub
+
+### Publishing to PyPI
+
+1. **Create a GitHub Release:**
+   - Go to: https://github.com/BioLM/jupyterlab-mlflow/releases/new
+   - Select the tag created by semantic-release (e.g., `v0.2.0`)
+   - Add release notes
+   - Click "Publish release"
+
+2. **Automatic Publishing:**
+   - The publish workflow automatically builds and publishes to PyPI
+   - No manual steps required after creating the release
+
+See [PUBLISHING.md](PUBLISHING.md) for detailed instructions.
+
+## License
+
+BSD-3-Clause
+