Metadata-Version: 2.4
Name: pyxel-config-lab-bridge
Version: 0.2.2
Summary: A Python bridge that opens the Pyxel Config Lab UI directly inside Jupyter Notebooks.
Home-page: https://gitlab.com/dobybaxter127/pyxel-config-lab
Author: Doby Baxter
License: MIT
Project-URL: Homepage, https://gitlab.com/dobybaxter127/pyxel-config-lab/-/tree/main/pyxel-config-lab-extension
Project-URL: Source, https://gitlab.com/dobybaxter127/pyxel-config-lab
Project-URL: Issues, https://gitlab.com/dobybaxter127/pyxel-config-lab/-/issues
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: ipython
Requires-Dist: ipykernel

# Pyxel Config Lab Bridge🪐

**Pyxel Config Lab Bridge** is a lightweight Python connector that allows Jupyter Notebooks to communicate with the **Pyxel Config Lab** JupyterLab extension.  
It sends a command from Python to open the Pyxel Config Lab interface inside your JupyterLab environment.

---

## ✨ Features

- Opens the Pyxel Config Lab UI directly from a notebook cell.  
- No JavaScript needed — pure Python bridge using Jupyter’s comms.  
- Easy to install and distribute.

---

## 🧩 Installation

### 1. Install via `pip`
```bash
pip install pyxel-config-lab-bridge
```

If you’re developing locally:
```bash
pip install -e .
```

### 2. Ensure the Pyxel Config Lab JupyterLab extension is installed
```bash
jupyter labextension install pyxel-config-lab
```

---

## 🚀 Usage

In any Jupyter Notebook cell:
```python
from pyxel_config_lab_bridge import open_pyxel_config_lab

open_pyxel_config_lab()
```

This will open the Pyxel Config Lab panel directly in your JupyterLab workspace.

---

## 🧠 How It Works

The bridge uses Jupyter’s comms (`ipykernel.comm.Comm`) to send a small message to the frontend extension.  
Once received, the frontend triggers the `pyxel-config-lab:open` command — which opens the Pyxel Config Lab iframe view.

---

## 📜 License

MIT © 2025 Doby Baxter
