• Stars
    star
    81
  • Rank 400,299 (Top 8 %)
  • Language
    TypeScript
  • License
    BSD 3-Clause "New...
  • Created almost 6 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Quickly open a file in JupyterLab by typing part of its name

jupyterlab-quickopen

Binder

Quickly open a file in JupyterLab by typing part of its name

Animation showing entering partial filenames in the quick open sidebar and the corresponding file editor opening

Compatibility

  • Python >=3.7.x
  • JupyterLab >=3.2,<4.0
  • Jupyter Server >=1.6,<2.0
  • Configurations where notebook documents and other files reside on a filesystem local to the Jupyter Server (which is the the default), not remote storage (e.g., S3)

Install

Starting in version 1.0 of this extension, the frontend portion of this extension is pre-compiled and included in the pip installed package thanks to changes in the JupyterLab 3.0 packaging system.

To install the Jupyter Notebook server extension under PREFIX (e.g., the active virtualenv or conda env), run the following:

pip install jupyterlab-quickopen

Configure

A Keyboard Shortcut

You can assign a keyboard shortcut to show the quickopen panel at any time. Open the keyboard editor by clicking Settings → Advanced Settings Editor → Keyboard Shortcuts. Then enter JSON in the User Overrides text area like the following, adjusting the keys value to assign the shortcut of your choosing:

{
  "shortcuts": [
    {
      "command": "quickopen:activate",
      "keys": ["Accel Ctrl P"],
      "selector": "body",
      "title": "Activate Quick Open",
      "category": "Main Area"
    }
  ]
}

Patterns to Exclude

You can control which files to exclude from the quick open list using Notebook server settings, JupyterLab settings, or both.

On the server side, use the ContentsManager.allow_hidden and/or ContentsManager.hide_globs settings. See the documentation about Jupyter Notebook options for details.

In the JupyterLab web app, open the Settings menu, click the Advanced Settings Editor option, select the Quick Open item in the Raw View sidebar, and enter JSON in the User Overrides text area to override the default values.

Screenshot of the quick open settings editor

Develop

The project includes a Makefile to aid setting up a development environment using python3, venv, and pip. You must also install the latest Node LTS release as a prerequisite.

# Create a dev environment
make venv

# Activate the dev environment
`make shell`

# In one terminal, watch the frontend source for changes and rebuild the extension
make watch

# In a second terminal, run JupyterLab.
`make shell`
make lab

Keep an eye on the terminal running make watch for TypeScript build errors. Quit and re-run the make lab command any time you make changes to the server extension.

Release

Make a commit with version number bumps in package.json. Then do the following.

# Tag the release commit
git tag -a -m "0.4.0" 0.4.0

# Activate the dev environment
`make shell`

# Build, sign, and push release to test.pypi.org
make release

# Build, sign and push releases to pypi.org
make release PYPI_URI=pypi

FAQ

Does this belong in JupyterLab?

Maybe. To start, I wanted to do some hacking and it's easiest to do that in a small, independent repo. Putting this feature into JupyterLab-proper requires making the server-side portion work with ContentManagers that are not based on the local filesystem. That change might require a new ContentManager API since walking the file hierarchy via HTTP calls is pretty heavyweight. Python/TypeScript tests are also required.

Will this extension work with JupyterLab 2.x?

Not since [version 0.5.0(https://github.com/parente/jupyterlab-quickopen/tree/0.5.0).

More Repositories

1

jupyterlab-variableInspector

Variable Inspector extension for Jupyterlab
TypeScript
1,096
star
2

jupyterlab_code_formatter

A JupyterLab plugin to facilitate invocation of code formatters.
Python
833
star
3

jupyterlab-vim

Vim notebook cell bindings for JupyterLab
TypeScript
667
star
4

spellchecker

Spellchecker for JupyterLab notebook markdown cells and file editor.
TypeScript
205
star
5

rise

RISE: "Live" Reveal.js JupyterLab Slideshow Extension
TypeScript
167
star
6

jupyterlab-spreadsheet-editor

JupyterLab spreadsheet editor for tabular data (e.g. csv, tsv)
TypeScript
130
star
7

jupyterlab-topbar

JupyterLab Top Bar extensions
TypeScript
106
star
8

jupyterlab-kernelspy

A Jupyter Lab extension for inspecting messages to/from a kernel
TypeScript
81
star
9

jupyterlab-unfold

An IDE-like file browser for JupyterLab
TypeScript
80
star
10

jupyter-archive

A Jupyter/Jupyterlab extension to make, download and extract archive files.
Python
76
star
11

jupyter-videochat

Video chat with peers inside JupyterLab
TypeScript
60
star
12

jupyterlab-tour

A JupyterLab UI tour built on jupyterlab-tutorial and react-joyride.
TypeScript
59
star
13

jupyterlab-link-share

JupyterLab Extension to easily share a link to a running server on Binder
TypeScript
53
star
14

jupyterlab-contrib.github.io

Management and website of JupyterLab Unofficial Extensions and Tools
Smarty
41
star
15

jupyter-ui-toolkit

UI Toolkit for Jupyter
TypeScript
40
star
16

jupyterlab-cell-flash

JupyterLab extension to show a flash effect when a cell is executed ⚡ ✨
TypeScript
39
star
17

jlab-enhanced-cell-toolbar

A cell toolbar for JupyterLab.
TypeScript
39
star
18

jupyterlab-filesystem-access

[Experimental] Browse local files using the non-standard File System Access API
TypeScript
30
star
19

jlab-enhanced-launcher

Alternative launcher for JupyterLab
TypeScript
25
star
20

jupyterlab-app-cookiecutter

Kickstart your JupyterLab based standalone application 🚀
TypeScript
22
star
21

jupyterlab_toastify

Customize 'react-toastify' to integrate nicely in JupyterLab.
TypeScript
22
star
22

search-replace

Search and replace accross files
TypeScript
21
star
23

jupyterlab-theme-editor

Extension providing a theme editor where colors, font families and font sizes of the elements of the user interface can be varied
TypeScript
21
star
24

jupyterlab-favorites

Add the ability to save favorite folders to JupyterLab for quicker browsing
TypeScript
14
star
25

jupyterlab-open-url-parameter

JupyterLab extension to open files passed via a URL parameter.
TypeScript
10
star
26

jupyterlab-pytutor

Python Tutor extension for JupyterLab
TypeScript
9
star
27

jupyterlab-plugin-graph

JupyterLab extension to show an interactive dependency graph of the installed plugins
TypeScript
9
star
28

jupyterlab-fileopen

A JupyterLab extension that adds a shortcut for opening files using the OS file explorer
Python
7
star
29

jupyterlab-gitlab

A JupyterLab extension for browsing GitLab repositories
TypeScript
5
star
30

ipylgbst

A widget library for controlling LEGO® BOOST via web-bluetooth
Python
4
star
31

jlab-image-editor

Simple image editor for JupyterLab
TypeScript
4
star
32

jupyterlab-logout

Log out button for JupyterLab
Python
3
star
33

jupyterlab-code-toc

Table of Contents JupyterLab extension with code content
TypeScript
3
star
34

react-auth-google-example

Example enabling users to log in with Google Identity service for webapps.
TypeScript
1
star
35

jupyterlab-topbar-text

JupyterLab extension to display arbitrary text in the top bar
Python
1
star
36

.github

Health files for the @jupyterlab-contrib organization
1
star
37

jupyterlab-browser-storage

A JupyterLab Drive to save files in the browser storage.
TypeScript
1
star