Metadata-Version: 2.4
Name: xtralab
Version: 0.1.2
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-light>=1.0.2
Requires-Dist: jupyterlab-cursor-theme>=1.0.1
Requires-Dist: jupyterlab-day>=0.2.0
Requires-Dist: jupyterlab-git<1,>=0.53.0
Requires-Dist: jupyterlab-night>=0.5.2
Requires-Dist: jupyterlab-quickopen>=2.1.0
Requires-Dist: jupyterlab>=4.6.0a5
Description-Content-Type: text/markdown

# xtralab

An opinionated JupyterLab meta-package.

`xtralab` bundles a curated set of JupyterLab extensions, ships its own
JupyterLab extension with a path-first file browser and a VS Code-style git
changes panel, and applies a quieter default workspace configuration. The
defaults are shipped under `etc/jupyter/labconfig` and the bundled
labextension is shipped under `share/jupyter/labextensions/xtralab`.

The goal is to keep the package easy to inspect: most behavior comes from the
upstream Jupyter packages, while `xtralab` defines the default environment we
want out of the box.

## Approach

The package brings together:

- The `ajlab` meta-package (agent-ready JupyterLab — collaboration plumbing, MCP support, command tooling, and its own quieter defaults)
- JupyterLab 4.6+
- Git server integration (`jupyterlab-git` — backs the bundled changes panel)
- Quick file opening (`jupyterlab-quickopen`)
- Cursor styling helpers (`jupyterlab-cursor-light`, `jupyterlab-cursor-theme`)
- Day and night themes (`jupyterlab-day`, `jupyterlab-night`)

These are installed as normal Python dependencies, so deployments can still
override versions and Jupyter configuration in the usual ways.

## Bundled labextension

`xtralab` ships its own prebuilt labextension that contributes:

- A path-first file browser in the left sidebar, built on `@pierre/trees`.
- A VS Code-style "Source Control" panel in the left sidebar, powered by the
  `jupyterlab-git` server REST API and `@pierre/diffs`. The bundled
  `@jupyterlab/git` frontend is disabled automatically so the two panels do
  not coexist.

## Default settings

`xtralab` ships the following JupyterLab defaults:

- The announcements plugin is disabled, so JupyterLab does not prompt to fetch
  news from the Jupyter news feed and does not check for application updates.
- The Table of Contents, Debugger, and Notebook Tools panels are disabled so
  they do not show up in the right sidebar by default.
- `dockPanelPadding` is off, so the main dock area is flush with the
  surrounding chrome.

The JupyterLab frontend defaults are shipped as `labconfig/*.d/00-xtralab.json`
fragments so downstream meta-packages can add their own Lab configuration
fragments without replacing `xtralab`'s files.

## Install

```bash
pip install xtralab
```

## Development

```bash
# Install dependencies and the package in editable mode
uv pip install -e ".[dev]"
jlpm
jlpm build
```

## License

BSD-3-Clause
