Skip to main content

JupyterHub Apps

Project description

JupyterHub Apps Launcher

Lint Test

JupyterHub Apps Launcher is a generalized server launcher. The goal of this project is to support launching anything like say a Flask Server, FastAPI server or a Panel Dashboard via a user supplied command. Currently, the following frameworks are supported:

  • Panel
  • Bokeh
  • Streamlit
  • Plotly Dash
  • Voila
  • Gradio
  • JupyterLab
  • Generic Python Command

JHub Apps Demo

Installation

pip install jhub-apps

or via conda

conda install -c conda-forge jhub-apps

Development Installation

Install Dependencies

conda env create -f environment-dev.yml
conda activate jhub-apps-dev
pip install -e .

Starting JupyterHub

Set the following environment variable:

export JHUB_APP_JWT_SECRET_KEY=$(openssl rand -hex 32)

Start JupyterHub:

jupyterhub -f jupyterhub_config.py

Now go to http://127.0.0.1:8000/hub/home to access JHub Apps Launcher

API Endpoints

The Hub service is exposed via FastAPI endpoints. The documentation for the same can be accessed at: http://127.0.0.1:10202/services/japps/docs

To try out authenticated endpoints click on the Authorize button on the top right of the above url and chose OAuth2AuthorizationCodeBearer and click on Authorize.

Developing Locally

Note: In order to develop locally, both the JupyterHub backend and React UI frontend should be running.

  1. To start the JupyterHub Backend, run the following in a terminal:
jupyterhub -f jupyterhub_config.py
  1. To start the React UI frontend, run the following in a separate terminal from the ui directory:
npm run watch

Running Tests

Unit Tests

pytest jhub_apps/tests

E2E Tests

pytest jhub_apps/tests_e2e -vvv -s --headed

Usage

JHub Apps has been tested with local JupyterHub using SimpleLocalProcessSpawner and with The Littlest JupyterHub using SystemdSpawner.

  • Install JHub Apps
pip install git+https://github.com/nebari-dev/jhub-apps.git
  • Add the following in The Littlest JupyterHub's jupyterhub_config.py
from tljh.user_creating_spawner import UserCreatingSpawner
from jhub_apps.configuration import install_jhub_apps

c.JupyterHub.bind_url = "<YOUR_JUPYTERHUB_URL>"
c.SystemdSpawner.unit_name_template = 'jupyter-{USERNAME}{JHUBSERVERNAME}'
c.JAppsConfig.apps_auth_type = "oauth" # or none (if you don't want authentication on apps)
c.JAppsConfig.python_exec = "python3"
# Pass in the path to jupyterhub config
c.JAppsConfig.jupyterhub_config_path = "jupyterhub_config.py"
# Either a static list of conda environments to show in the
# create panel apps form or a callable to fetch conda enviornments
# dynamically, e.g. from conda-store API
c.JAppsConfig.conda_envs = []
c = install_jhub_apps(c, UserCreatingSpawner)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jhub_apps-2024.6.1.tar.gz (14.9 MB view details)

Uploaded Source

Built Distribution

jhub_apps-2024.6.1-py3-none-any.whl (3.8 MB view details)

Uploaded Python 3

File details

Details for the file jhub_apps-2024.6.1.tar.gz.

File metadata

  • Download URL: jhub_apps-2024.6.1.tar.gz
  • Upload date:
  • Size: 14.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for jhub_apps-2024.6.1.tar.gz
Algorithm Hash digest
SHA256 0297465b9ebd23154d0beb2f8b7d5d19d15ed3b4dab5ad15dd9b294da5eceb3f
MD5 f3e62bc564faacf98591dbe0449deb01
BLAKE2b-256 0b58c048399028dfa0819b5f20fb87e689236c74ae3c25d55b807f74e8b54a6e

See more details on using hashes here.

Provenance

File details

Details for the file jhub_apps-2024.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jhub_apps-2024.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3e2264449ac0138192d64f7eb76832754268946e8120bc1701bdd5cb6897ab47
MD5 0aa856a64114c9b541bfa687579af1ca
BLAKE2b-256 89ece1866e3db79cf2f748c18e6202f484fef22739c7a22cbc3599a29740f2b4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page