Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nandor-poka/jupyterlab-bookmarks-extension
JupyterLab Favorites extension for JupyterLab 2.0+. Provides Launcher icons for favorite / bookmarked files.
https://github.com/nandor-poka/jupyterlab-bookmarks-extension
bookmarks extension favorites jupyterlab
Last synced: 2 months ago
JSON representation
JupyterLab Favorites extension for JupyterLab 2.0+. Provides Launcher icons for favorite / bookmarked files.
- Host: GitHub
- URL: https://github.com/nandor-poka/jupyterlab-bookmarks-extension
- Owner: nandor-poka
- License: bsd-3-clause
- Created: 2020-07-01T13:00:07.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T14:43:00.000Z (over 4 years ago)
- Last Synced: 2024-11-20T04:26:23.539Z (3 months ago)
- Topics: bookmarks, extension, favorites, jupyterlab
- Language: TypeScript
- Homepage: https://np-bio.info/
- Size: 639 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - nandor-poka/jupyterlab-bookmarks-extension - JupyterLab Favorites extension for JupyterLab 2.0+. Provides Launcher icons for favorite / bookmarked files. (TypeScript)
README
# jupyterlab-bookmarks-extension
[](https://badge.fury.io/py/jupyterlab-bookmarks-extension)
[](https://www.codacy.com/manual/np/jupyterlab-bookmarks-extension?utm_source=github.com&utm_medium=referral&utm_content=nandor-poka/jupyterlab-bookmarks-extension&utm_campaign=Badge_Grade)
A JupyterLab extension to provide Launcher icons for favorites. Allows bookmarking files for quick access from the Launcher.
This extension is composed of a Python package named `jupyterlab_bookmarks_extension`
for the server extension and a NPM package named `jupyterlab-bookmarks-extension`
for the frontend extension.
## Intro
## Requirements
* JupyterLab >= 2.0 (preferably 2.2.0)
## Install
Note: You will need NodeJS to install the extension.
```bash
pip install jupyterlab_bookmarks_extension
jupyter lab build
```
## Troubleshoot
If you are seeing the frontend extension but it is not working, check
that the server extension is enabled:
```bash
jupyter serverextension list
```
If the server extension is installed and enabled but you are not seeing
the frontend, check the frontend is installed:
```bash
jupyter labextension list
```
If it is installed, try:
```bash
jupyter lab clean
jupyter lab build
```
## Contributing
### Install for development
The `jlpm` command is JupyterLab's pinned version of
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# Clone the repo to your local environment
# Move to jupyterlab-bookmarks-extension directory
# Install server extension
pip install -e .
# Register server extension
jupyter serverextension enable --py jupyterlab_bookmarks_extension --sys-prefix
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```
Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
### Uninstall
```bash
pip uninstall jupyterlab_bookmarks_extension
jupyter labextension uninstall jupyterlab-bookmarks-extension
```