https://github.com/jupyterlite/repo2jupyterlite

Build jupyterlite apps out of repositories
https://github.com/jupyterlite/repo2jupyterlite

Last synced: 14 days ago
JSON representation

Build jupyterlite apps out of repositories

• Host: GitHub
• URL: https://github.com/jupyterlite/repo2jupyterlite
• Owner: jupyterlite
• License: bsd-3-clause
• Created: 2022-07-01T17:34:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-02T09:24:03.000Z (7 months ago)
• Last Synced: 2024-04-14T03:08:20.061Z (7 months ago)
• Language: Python
• Size: 74.2 KB
• Stars: 26
• Watchers: 6
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# repo2jupyterlite

Build jupyterlite apps out of repositories

## Installation

Install from PyPI:

```bash

pip install repo2jupyterlite

```

## Build a repo

You can use the `repo2jupyterlite` command to check out any supported repo

(Git, Dataverse, Figshare, Local filestore, etc) and builds a jupyterlite

installation with `jupyter lite build`.

```bash

repo2jupyterlite https://github.com/yuvipanda/environment.yml requirements-build

```

You can serve the `requirements-build/` directory now statically, and it should

have the contents of the repo be present!

# binderlite

A simple web app to dynamically build and serve jupyterlite instances.

## How to run

1. Create a new conda env with required dependencies

   ```

   mamba env create -n binderlite -f environment.yml

   ```

2. Install repo2jupyterlite from this repo

   ```bash

   pip install -e .

   ```

3. Use `uvicorn` to run the web app

   ```bash

   uvicorn binderlite.run:app

   ```