Skip to main content

girder_jupyter

Build Status PyPI version PyPI status

The Jupyter Notebook web application provides a graphical interface for creating, opening, renaming, and deleting files in a virtual filesystem. girder_jupyter is a python package that implements a contents manager to allow Girder to become a backend for this virtual filesystem. This allows notebooks and files to be stored in a Girder server from within Jupyter.

Getting Started

Install the package in the Python environment you are running your Jupyter server in:

pip install girder-jupyter

Add the following options to your jupyter_notebook_config.py

c.NotebookApp.contents_manager_class = 'girder_jupyter.contents.manager.GirderContentsManager'
c.GirderContentsManager.api_key = '<api key>'
c.GirderContentsManager.api_url = '<api url>'

Where <api key> is replaced with a Girder API key for the Girder server and <api url> is the URL to Girder instance you want to use for example http://localhost:8080/api/v1.

Configuration Parameters

  • api_url - An API URL for the Girder server. Defaults to ‘http://localhost:8080/api/v1’

  • api_key -A Girder API key key for the Girder server at api_url. The key should have read and write permission scope.

  • token - A Girder token for the Girder server at api_url. This parameter is particularly useful when running instances from JupyterHub.

  • root - The root in the Girder hierarchy to use as the content managers root. This path can include {login} which will be replace with the current users login. Defaults to 'user/{login}'

Note that either api_key or token must be provided for the contents manager to be able to authenticate with the Girder server.

Metadata

Release files for girder-jupyter 0.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for girder-jupyter 0.2.2
File Size Uploaded
girder-jupyter-0.2.2.tar.gz 14.4 kB Details

Release files / girder-jupyter-0.2.2.tar.gz

Download URL girder-jupyter-0.2.2.tar.gz
Size 14.4 kB
Tags Source
SHA-256 checksum
How to use checksums
b77599d7d499a511e3d5243be935c03f66ff1a2ae1923dd3d5fd6fe899cecd2d
BLAKE2b-256 checksum
How to use checksums
ea0119f8c7534bc4823800102093bb19c9ef9be5f7fda5db82ec162058911eca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/28.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.1
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page