Extension Jupyternotebook


Extension Basics

Title
Jupyternotebook
Name
ckanext-jupyternotebook
Type
Public extension
Description
No description provided
CKAN versions
Download-Url (zip)
Last commit
8 months ago (2025-05-05 07:18:53)
Url to repo
Category
Authentication & Security


Background Infos

Description (long)
Show details

ckanext-jupyternotebook Plugin

This plugin integrates JupyterHub with CKAN, allowing users to execute and temporarily edit interactive Jupyter notebooks within the CKAN environment. The plugin makes data exploration and analysis more accessible and integrated.

Features

  • Integration of Jupyter Notebooks within CKAN
  • Temporary notebook editing and execution
  • Utilize DockerSpawner to create isolated Docker containers for each user, ensuring a secure and personalized computational environment.
  • Guest user access without login
  • Admin-configurable maximum number of concurrent guest users

How it works

  1. Users access Jupyter notebooks through the CKAN interface.
  2. Each user is provided with a temporary, isolated Docker container.
  3. Users can edit notebook cells and install libraries during their session.
  4. After a predefined timeout, all changes are automatically reverted.
  5. Guest users can access notebooks without logging in, subject to availability.

Architecture

The extension consists of two main components:

  1. CKAN Extension (ckanext-jupyternotebook)

    • Core CKAN plugin functionality
    • Views and templates for notebook interaction
    • Controllers for handling notebook operations
  2. JupyterHub Component (jupyterhub)

    • Runs as a separate Docker container
    • Manages notebook instances
    • Provides API endpoints for user management

Installation

As usual for CKAN extensions, you can install ckanext-jupyternotebook as follows:

git clone git@github.com:SDM-TIB/ckanext-jupyternotebook.git
pip install -e ./ckanext-jupyternotebook
pip install -r ./ckanext-jupyternotebook/requirements.txt

Configure Environment Variables

Configure the .env file with the following required variables::

  • CKAN_JUPYTERNOTEBOOK_URL: The base URL for JupyterHub access
  • CKAN_JUPYTERHUB_BASE_URL: The base path for JupyterHub
  • CKAN_NETWORK: Docker network name
  • CKAN_STORAGE_NOTEBOOK: Path to notebook storage
Version
Version release date
(not set)
Contact name
(not set)
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

As usual for CKAN extensions, you can install ckanext-jupyternotebook as follows:

git clone git@github.com:SDM-TIB/ckanext-jupyternotebook.git
pip install -e ./ckanext-jupyternotebook
pip install -r ./ckanext-jupyternotebook/requirements.txt
Plugins to configure (ckan.ini)
jupyternotebook
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions