Metadata-Version: 2.1
Name: jupyter-pluto-proxy
Version: 0.1.0
Summary: hello@illumidesk.com
Home-page: https://github.com/illumidesk/jupyter-pluto-proxy
Author: IllumiDesk Team
Keywords: jupyter notebook,pluto notebook,jupyterhub,jupyterlab,jupyter-server-proxy
Classifier: Framework :: Jupyter
Description-Content-Type: text/markdown
Requires-Dist: jupyter-server-proxy (>=1.5.0)

# Jupyter Server Proxy + Pluto.jl

Launch the awesome Pluto.jl Notebook from the Jupyter Lab `Launcher` or the Jupyter Classic `New` dropdown. This package was built using the [`jupyter-server-proxy` cookiecutter template](https://github.com/illumidesk/cookiecutter-jupyter-server-proxy).

## Launch

Take it for a spin with Binder:

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/illumidesk/jupyter-pluto-proxy/main?urlpath=pluto)

Then, from the the Jupyter Lab Launcher --> Pluto. Alternatively, from Jupyter Notebook Classic (change the path in your browser to use `/tree`) click on `New` --> `Pluto Notebook`.

## Requirements

- [Python 3.6+](https://www.python.org/downloads/)
- [Docker](https://docs.docker.com/get-docker/)

## Launch

```bash
make build
```

The `make build` command creates your virtual environment with `virtualenv` and Python3, installs the required dependencies, and then launches your notebook with an arbritrary port with `repo2docker`.

## Development

1. Fork and clone this repo and install the package:

```bash
git clone https://github.com/<account>/jupyter-pluto-proxy
```

2. Create and activate a virtual environment:

```bash
virtualenv -p python3 venv
source venv/bin/activate
```

3. Install package:

```bash
cd jupyter-pluto-proxy
pip install -e .
```

## Credits

- [`jupyter-server-proxy`](https://github.com/jupyterhub/jupyter-server-proxy)
- [`Pluto.jl](https://github.com/fonsp/Pluto.jl)

## License

BSD 3-Clause
