Metadata-Version: 2.4
Name: jupyterhub_rag_sidebar
Version: 0.2.0
Dynamic: Project-URL
Summary: JupyterLab sidebar chatbot grounded in the CSUF JupyterHub user guide.
Author-email: Jannik Hofmann <jannikhofmann2000@web.de>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: jupyter,jupyterlab,jupyterlab-extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
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: jupyter-server<3,>=2.4.0
Requires-Dist: jupyterhub-rag
Provides-Extra: dev
Requires-Dist: jupyter-builder>=1.0.0; extra == 'dev'
Requires-Dist: jupyterlab>=4; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage; 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

# jupyterhub_rag_sidebar

JupyterLab sidebar chatbot grounded in the CSUF JupyterHub user guide.

This extension is composed of a Python package named `jupyterhub_rag_sidebar`
for the server extension and a NPM package named `jupyterhub-rag-sidebar`
for the frontend extension. It lives inside the `jupyterhub-user-guide-rag`
repo (not published as a standalone package) — see the parent repo's
`README.md` for how this piece fits into the rest of the RAG pipeline.

## Requirements

- JupyterLab >= 4.0.0

## Install

There's no published package to install from — build and install it from
source:

```bash
pip install -e ".[dev,test]"
jlpm build
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for the full development workflow.

## Uninstall

To remove the extension, execute:

```bash
pip uninstall jupyterhub_rag_sidebar
```

## Troubleshoot

If you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:

```bash
jupyter server extension list
```

If the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:

```bash
jupyter labextension list
```

## Contributing

See the [Contributing Guide](CONTRIBUTING.md).
