Metadata-Version: 2.4
Name: vre-jupyterlab-extension
Version: 0.1.11
Summary: VRE JupyterLab Extension with VRE DSL highlighting and notebook execution guard
Project-URL: Repository, https://github.com/officiallygod/vre-jupyterlab-extension
Project-URL: Issues, https://github.com/officiallygod/vre-jupyterlab-extension/issues
License: BSD 3-Clause License
        
        Copyright (c) 2026, Karlsruhe Institute of Technology
        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
Classifier: Development Status :: 5 - Production/Stable
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: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.10
Requires-Dist: jupyterlab<5,>=4.2
Description-Content-Type: text/markdown

# vre-jupyterlab-extension


[![CI](https://github.com/officiallygod/vre-jupyterlab-extension/actions/workflows/extension-pr-ci.yml/badge.svg)](https://github.com/officiallygod/vre-jupyterlab-extension/actions/workflows/extension-pr-ci.yml)
[![PyPI](https://img.shields.io/pypi/v/vre-jupyterlab-extension.svg)](https://pypi.org/project/vre-jupyterlab-extension)
[![PyPI Downloads](https://static.pepy.tech/badge/vre-jupyterlab-extension)](https://pepy.tech/projects/vre-jupyterlab-extension)
[![Python](https://img.shields.io/pypi/pyversions/vre-jupyterlab-extension.svg)](https://pypi.org/project/vre-jupyterlab-extension)
[![Wheel](https://img.shields.io/pypi/wheel/vre-jupyterlab-extension.svg)](https://pypi.org/project/vre-jupyterlab-extension)
[![JupyterLab](https://img.shields.io/badge/JupyterLab-4.x-F37626?logo=jupyter)](https://jupyterlab.readthedocs.io/en/stable/)
[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-green)](https://officiallygod.github.io/vre-jupyterlab-extension/)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](LICENSE)

![VRE logo](https://raw.githubusercontent.com/officiallygod/vre-jupyterlab-extension/refs/heads/main/style/vre-logo-64x64.png)

A prebuilt JupyterLab 4 extension that provides CodeMirror 6 highlighting for the VRE DSL and a simple execution guard.

Why this package

- No Node tooling required for end users as the wheel embeds the prebuilt labextension assets.
- Installable via pip and ready to use in a JupyterLab environment.

Quick install

```bash
pip install vre-jupyterlab-extension
jupyter lab
```

Developer / Build from source

```bash
cd packages/vre-jupyterlab-extension
npm ci
npm run build
python -m pip install --upgrade build
python -m build --wheel --sdist
python -m pip install dist/vre_jupyterlab_extension-*.whl
```

Release (package-local)

You can run the release flow from inside the package directory. The package provides a helper that:

- prompts for the new semantic version
- updates `package.json`, `setup.cfg`, and `vre_jupyterlab_extension/__init__.py`
- removes build artifacts (`dist`, `build`, `lib`, `labextension`, `*.egg-info`, ...)
- runs `npm ci`, builds frontend assets, and builds a Python wheel and sdist

Usage (from repository root):

```bash
cd packages/vre-jupyterlab-extension
npm run release
# or run directly
python3 ./scripts/release.py
```

Notes:

- The README uses the PyPI badge to show the published version dynamically. Avoid hardcoding the version string in the README so the badge stays authoritative.
- The package-local `release` script is intentionally self-contained and safe to run from the package folder.

Release checklist and publish flow

1. Create a release branch or PR title containing `release` (for example: `release/0.1.4`).
2. The workflow `.github/workflows/release-pr-checklist.yml` will auto-insert a release checklist into the PR description if missing.
3. Complete the checklist items before merge.
4. Merge, create and push a tag like `v0.1.4`.
5. The publish workflow `.github/workflows/extension-publish.yml` publishes to PyPI and GitHub Packages.
6. Detailed release checklist and commands: see `RELEASE.md`.

Documentation

Full documentation is available at https://officiallygod.github.io/vre-jupyterlab-extension/

Local development: run `mkdocs serve` from this directory after installing `requirements_docs.txt`.

Runtime requirements

- `jupyterlab>=4.2,<5`

Notes

- The wheel includes `labextension/` and `install.json`; `setup.py` copies these assets into the wheel during the build step.

PyPI Repository:
[vre-jupyterlab-extension](https://pypi.org/project/vre-jupyterlab-extension/)

Contributing

Please see the repository CONTRIBUTING guidelines and open issues to discuss changes.

License

BSD-3-Clause
