Metadata-Version: 2.4
Name: scicat_widget
Version: 26.2.1
Summary: SciCat dataset widget
Project-URL: Bug Tracker, https://github.com/jl-wynen/scicat_widget/issues
Project-URL: Source, https://github.com/jl-wynen/scicat_widget
License-File: LICENSE
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 :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: anywidget>=0.9.21
Requires-Dist: ipykernel>=6.30.1
Requires-Dist: jupyter-host-file-picker>=26.2.1
Requires-Dist: pydantic>=2.12
Requires-Dist: scitacean>=26.2.0
Description-Content-Type: text/markdown

# widget

## Installation

```sh
pip install widget
```

or with [uv](https://github.com/astral-sh/uv):

```sh
uv add widget
```

## Development

We recommend using [uv](https://github.com/astral-sh/uv) for development.
It will automatically manage virtual environments and dependencies for you.

```sh
uv run jupyter lab example.ipynb
```

Alternatively, create and manage your own virtual environment:

```sh
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
jupyter lab example.ipynb
```

The widget front-end code bundles it's JavaScript dependencies. After setting up Python,
make sure to install these dependencies locally:

```sh
npm install
```

While developing, you can run the following in a separate terminal to automatically
rebuild JavaScript as you make changes:

```sh
npm run dev
```

Open `example.ipynb` in JupyterLab, VS Code, or your favorite editor
to start developing. Changes made in `js/` will be reflected
in the notebook.
