Initial implementation

Author: parente

.coveragerc

@@ -0,0 +1,9 @@
+[run]
+source=jupyterlab_quickopen
+[report]
+omit =
+    */python?.?/*
+    *test*
+    # ignore _version.py and versioneer.py
+    .*version.*
+    *_version.py

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 100

.gitignore

@@ -0,0 +1,97 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+doc/_build
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+cover/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+cover/
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Rope
+.ropeproject
+
+# Django stuff:
+*.log
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+#mac
+.DS_Store
+*~
+
+#pycharm
+.idea/*
+
+#Dolphin browser files
+.directory/
+.directory
+
+#Binary data files
+*.volume
+*.am
+*.tiff
+*.tif
+*.dat
+*.DAT
+
+#generated documntation files
+generated/
+
+#ipython notebook
+.ipynb_checkpoints/
+
+#vim
+*.swp
+
+#data files
+*.zip
+*.jpg
+
+# ctags
+.tags*
+
+# VSCode
+.vscode/
+
+# Node
+node_modules/

.travis.yml

@@ -0,0 +1,8 @@
+language: python
+python:
+  - '3.6'
+install:
+  - pip install -r requirements.txt -r requirements-test.txt
+script:
+  - make pytest
+  - make jstest

LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2018, Peter Parente
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,3 @@
+include versioneer.py
+include jupyterlab_quickopen/_version.py
+recursive-include config *.json

Makefile

@@ -0,0 +1,38 @@
+SHELL:=bash
+PKG_SLUG:=jupyterlab-quickopen
+PKG_NAME:=jupyterlab_quickopen
+CONDA_ENV:=jupyterlab-ext2
+
+help:
+# http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+clean: ## Make a clean source tree
+	-find . -name '*.pyc' -exec rm -fv {} \;
+	rm -rf $(PKG_NAME)/__pycache__ __pycache__
+	rm -rf *.egg-info
+	rm -rf node_modules
+	rm -rf lib
+
+activate: ## Make a conda activation command for eval
+	@echo "source activate $(PKG_SLUG)"
+
+conda-env: ## Make a conda development environment
+	conda create -n $(PKG_SLUG) -c conda-forge python=3 \
+		--file requirements.txt --file requirements-dev.txt
+	source activate $(PKG_SLUG) && \
+		jlpm install && \
+		jupyter labextension install . --no-build
+	source activate $(PKG_SLUG) && \
+		pip install -e . && \
+		jupyter serverextension enable $(PKG_NAME)
+
+release: ## Make a release on PyPI and npmjs.org
+	# python setup.py sdist register upload
+	# npm upload
+
+watch-lab: ## Make a JupyterLab build process watch for extension builds
+	source activate $(PKG_SLUG) && jupyter lab --watch
+
+watch-src: ## Make a TypeScript build process watch for source changes
+	source activate $(PKG_SLUG) && jlpm run watch

README.md

@@ -0,0 +1,101 @@
+# jupyterlab-quickopen
+
+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](./doc/quickopen.gif)
+
+## Compatibility
+
+* JupyterLab 0.35.x
+* Jupyter Notebook >=5.2.x
+* Notebook server configurations where notebook documents and other files reside
+  on the local filesystem (which is the the notebook server default)
+
+## Install
+
+Install the Jupyter Notebook server extension under `PREFIX` (e.g., the active
+virtualenv or conda env).
+
+```
+pip install jupyterlab-quickopen
+```
+
+Then install the JupyterLab frontend extension.
+
+```
+jlpm install @parente/jupyterlab-quickopen
+```
+
+### Install Alternatives
+
+You can use `jupyter serverextension` commands to enable and disable the
+server extension in different contexts, e.g.:
+
+```
+jupyter serverextension enable --py jupyterlab_quickopen --user
+jupyter serverextension disable --py jupyterlab_quickopen --sys-prefix
+```
+
+## 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:
+
+```
+{
+    "quickopen:activate": {
+      "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](https://jupyter-notebook.readthedocs.io/en/stable/config.html)
+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](./doc/settings.png)
+
+## Develop
+
+The project includes a Makefile which makes setting up a development environment
+using `conda` easy.
+
+```
+# Create a conda environment and install the lab/server extensions
+make conda-env
+
+# In one terminal, watch the frontend extension source for changes and rebuild
+# the extension package
+make watch-src
+
+# In a second terminal, watch for rebuilt extension packages and rebuild
+# jupyterlab to include them
+make watch-lab
+```
+
+Keep an eye on the terminal running `watch-src` for TypeScript build errors.
+Keep an eye on the terminal running `watch-lab` to know when to refresh your
+browser. Quit and re-run the `make watch-lab` command any time you make
+changes to the **server** extension.

config/jupyterlab_quickopen.json

@@ -0,0 +1,7 @@
+{
+  "NotebookApp": {
+    "nbserver_extensions": {
+    "jupyterlab_quickopen": true
+    }
+  }
+}