Metadata-Version: 2.4
Name: xtralab
Version: 0.3.0
Summary: An opinionated JupyterLab meta-package that bundles a curated set of extensions, ships a path-first file browser and a VS Code-style git changes panel, and applies a quieter default workspace configuration.
Project-URL: Homepage, https://github.com/jtpio/xtralab
Project-URL: Bug Tracker, https://github.com/jtpio/xtralab/issues
Project-URL: Repository, https://github.com/jtpio/xtralab.git
Author: Jeremy Tuloup
License: BSD 3-Clause License
        
        Copyright (c) 2026, Jeremy Tuloup
        
        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,meta-package
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: ajlab>=0.1.5
Requires-Dist: jupyterlab-cursor-dark>=1.0.2
Requires-Dist: jupyterlab-cursor-light>=1.0.2
Requires-Dist: jupyterlab-day>=0.2.0
Requires-Dist: jupyterlab-git<1,>=0.53.0
Requires-Dist: jupyterlab-lsp<6,>=5.3.0
Requires-Dist: jupyterlab-night>=0.5.2
Requires-Dist: jupyterlab-quickopen>=2.2.0
Requires-Dist: jupyterlab-vim<5,>=4.1.4
Requires-Dist: jupyterlab>=4.6.0a5
Requires-Dist: ty>=0.0.35
Description-Content-Type: text/markdown

# xtralab

An opinionated JupyterLab meta-package.

Bundles a curated set of extensions, a path-first file browser, a VS Code-style
git changes panel, an agent-focused launcher, and a quieter default workspace.

## Install

```bash
pip install xtralab
```

## Usage

### As a JupyterLab package

Run JupyterLab the usual way:

```bash
jupyter lab
```

### As a desktop app

A standalone Electron build (DMG on macOS, AppImage on Linux) ships with each
tagged release — grab the installer for your platform from the
[Releases page](https://github.com/jtpio/xtralab/releases/latest). Builds from
the current `main` branch are also produced on every push as workflow
artifacts under the repository's
[Actions tab](https://github.com/jtpio/xtralab/actions). See
[CONTRIBUTING.md](./CONTRIBUTING.md) for the architecture and local build
instructions.

## What's included

- [`ajlab`](https://github.com/jtpio/ajlab) — agent-ready JupyterLab base
- JupyterLab 4.6+
- `jupyterlab-git` — backs the bundled changes panel
- `jupyterlab-lsp` + `ty` — Python LSP via Astral's `ty` (bundled); also
  detects `typescript-language-server` on `PATH` for JS/TS
- `jupyterlab-quickopen`
- `jupyterlab-cursor-light`, `jupyterlab-cursor-dark`
- `jupyterlab-day`, `jupyterlab-night` themes

The bundled labextension adds:

- A path-first file browser in the left sidebar.
- A "Source Control" panel powered by `jupyterlab-git` and `@pierre/diffs`.
- An agent launcher with a prompt textarea, a row of agent buttons (Claude,
  Codex, Gemini, Copilot, Goose, OpenCode, Kiro, Mistral Vibe), and a
  collapsible list of changed files. Buttons are filtered to agents installed
  on the machine; a typed prompt is shell-quoted and spliced into the launch
  command for agents that accept one.

## Language servers

xtralab ships with
[`jupyterlab-lsp`](https://github.com/jupyter-lsp/jupyterlab-lsp) and
pre-registers two language servers through
`jupyter_server_config.d/xtralab-lsp.json`:

- **Python — [`ty`](https://github.com/astral-sh/ty)** — installed as a
  Python dependency. Works out of the box.
- **TypeScript / JavaScript — `typescript-language-server`** — install
  yourself:

  ```bash
  npm install -g typescript-language-server typescript
  ```

  Restart JupyterLab (or the desktop app) after installing.

Specs use bare command names (`["ty", "server"]`), so binaries are resolved
from `PATH` at spawn time.

### Where binaries are discovered

- **`pip install xtralab`** — anything on the JupyterLab process's `PATH`.
- **Desktop app** — the supervisor augments `PATH` with common shim
  locations (`~/.volta/bin`, `~/.npm-global/bin`, `~/.bun/bin`,
  `~/.asdf/shims`, `~/.mise/shims`, `/opt/homebrew/bin`, `/usr/local/bin`,
  …). Set `XTRALAB_EXTRA_PATH` (colon-separated) before launching the app
  to add directories the defaults miss.

### Adding more servers

To enable another server (bash, yaml, json, dockerfile, pyright, …),
install the binary then drop a JSON file into a `jupyter_server_config.d/`
directory:

- **`pip install xtralab`** — run `jupyter --paths` and pick a config dir
  (typically `~/.jupyter/jupyter_server_config.d/`).
- **Desktop app (macOS)** —
  `~/Library/Application Support/xtralab/jupyter/config/jupyter_server_config.d/`
  (or `xtralab dev` for local dev builds).
- **Desktop app (Linux AppImage)** —
  `~/.config/xtralab/jupyter/config/jupyter_server_config.d/`.

Example (`bash-lsp.json`):

```json
{
  "LanguageServerManager": {
    "language_servers": {
      "bash-language-server": {
        "version": 2,
        "argv": ["bash-language-server", "start"],
        "languages": ["bash", "sh"],
        "mime_types": ["text/x-sh", "application/x-sh"],
        "display_name": "bash-language-server"
      }
    }
  }
}
```

Pair with `npm install -g bash-language-server`. Reuse a bundled `key` to
override it. See
[jupyterlab-lsp's docs](https://jupyterlab-lsp.readthedocs.io/en/latest/Configuring.html)
for the full spec schema.

## Customizing the launcher

Open `Settings → Settings Editor → xtralab launcher` and edit the `agents`
array. Entries are merged with the defaults by `id`.

```jsonc
{
  "agents": [
    // Hide an agent
    { "id": "kiro", "enabled": false },

    // Override an agent's command (e.g. point Claude at a shell alias)
    { "id": "claude", "command": "cl", "requireAvailable": false },

    // Add a new agent; promptArgs: [] appends the prompt as a positional arg
    { "id": "aider", "label": "Aider", "command": "aider", "promptArgs": [] }
  ]
}
```

Fields: `id` (required), `label`, `caption`, `command`, `promptArgs` (how to
splice the prompt — `[]` for positional, `["--flag"]` for flagged, `null` to
opt out), `iconSvg`, `rank`, `enabled`, `requireAvailable`.

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md) for the development setup, the
Electron desktop app architecture, and the build pipeline.

## License

BSD-3-Clause
