Skip to main content

Add the ability to save favorite folders to JupyterLab for quicker browsing

Project description

jupyterlab-favorites

Extension status Github Actions Status Binder npm PyPI conda-forge

Add the ability to save favorite folders to JupyterLab for quicker browsing.

Installation

Prerequisites

  • JupyterLab 3.x

Install from pypi

python -m pip install jupyterlab-favorites

Install from github

python -m pip install "git+https://github.com/jupyterlab-contrib/jupyterlab-favorites@v3.0.0#egg=jupyterlab_favorites"

Install locally from a git checkout

git clone https://github.com/jupyterlab-contrib/jupyterlab-favorites.git
cd jupyterlab-favorites
pip install .

Development

Prerequisites

  • An active conda environment with JupyterLab 3.x installed

Install locally from a git checkout

git clone https://github.com/jupyterlab-contrib/jupyterlab-favorites.git
cd jupyterlab-favorites
pip install -ve .

This copies the frontend code for the extension into JupyterLab.

To keep the source code synced with JupyterLab, you can run the following:

jupyter labextension develop --overwrite .

To rebuild the extension manually after each change::

jlpm run build

To automatically rebuild after each change, run in a separate terminal:

jlpm run watch

Older JupyterLab versions

JupyterLab v2 Support

NPM install

jupyter labextension install jupyterlab-favorites@2.0.0

Jupyterlab v1 Support

Via NPM:

jupyter labextension install jupyterlab-favorites@1.0.0

Or use the tagged 1.0.0 release at: https://github.com/jupyterlab-contrib/jupyterlab-favorites/tree/v1.0.0

Testing

Download Firefox browser if not already installed: https://www.mozilla.org/en-US/firefox/new/

Install Selenium:

conda install -c conda-forge selenium

Install Pytest:

conda install -c anaconda pytest

Change directory to this repo after cloning

cd yourfolder/jupyterlab-favorites

Running test script:

./run_tests.sh

This will open jupyter lab and run available tests. Note: You will need to run in a clean jupyter environment (without existing favorites files)

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

jupyterlab_favorites-3.0.1.tar.gz (133.2 kB view details)

Uploaded Source

Built Distribution

jupyterlab_favorites-3.0.1-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_favorites-3.0.1.tar.gz.

File metadata

  • Download URL: jupyterlab_favorites-3.0.1.tar.gz
  • Upload date:
  • Size: 133.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for jupyterlab_favorites-3.0.1.tar.gz
Algorithm Hash digest
SHA256 6102c164775b67ffa0f97df275c4d76a3603eaf49eed2887f2368012b1924f2c
MD5 79b26b5ad48819aa201820dbe0debefb
BLAKE2b-256 c577623ff7bfa4cdab42f2607b03c00e91684827bb21c416cbc21f75e2d552e4

See more details on using hashes here.

File details

Details for the file jupyterlab_favorites-3.0.1-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_favorites-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 33.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for jupyterlab_favorites-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72b4816fccfa6edd094c0e0c88865a53f12b7eff7dbfab8bb6b7a2048c4aced9
MD5 cc2bf4e18ca391a12efba925c87db32a
BLAKE2b-256 965e7843d99a336dcc316357b90eaa206bd2ae86e022466416376defdd5edddb

See more details on using hashes here.

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