Metadata-Version: 2.4
Name: aviary.notebook
Version: 0.28.0
Summary: Jupyter notebook environment implemented with aviary
Author-email: FutureHouse technical staff <hello@futurehouse.org>
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: Pillow
Requires-Dist: aiodocker
Requires-Dist: fhaviary
Requires-Dist: ipykernel
Requires-Dist: jupyter-client
Requires-Dist: litellm
Requires-Dist: nbformat
Requires-Dist: numpy
Requires-Dist: pydantic~=2.0
Provides-Extra: dev
Requires-Dist: matplotlib; extra == "dev"

# aviary.notebook

A Jupyter notebook environment.

## Installation

To install the notebook environment, run the following command:

```bash
pip install 'fhaviary[notebook]'
```

To allow the environment to run notebooks in containerized sandboxes (recommended), first build the default image:

```bash
cd docker/
docker build -t aviary-notebook-env -f Dockerfile.pinned .
```

And second, set the environment variable `NB_ENVIRONMENT_USE_DOCKER=true`.
You may use your own Docker image with a different name,
in which case you must override the environment variable `NB_ENVIRONMENT_DOCKER_IMAGE`.
