Metadata-Version: 2.1
Name: jupyterlab-favorites
Version: 3.1.0
Summary: Add the ability to save favorite folders to JupyterLab for quicker browsing
Home-page: https://github.com/jupyterlab-contrib/jupyterlab-favorites
Author: Trevor Slaton
License: BSD-3-Clause
Keywords: jupyter,jupyterlab,jupyterlab-extension
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 3
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# jupyterlab-favorites

[![Extension status](https://img.shields.io/badge/status-ready-success "ready to be used")](https://jupyterlab-contrib.github.io/)
[![Github Actions Status](https://github.com/jupyterlab-contrib/jupyterlab-favorites/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-favorites/actions?query=workflow%3ABuild)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-favorites/master?urlpath=lab)
[![npm](https://img.shields.io/npm/v/@jlab-enhanced/favorites)](https://www.npmjs.com/package/@jlab-enhanced/favorites)
[![PyPI](https://img.shields.io/pypi/v/jupyterlab-favorites)](https://pypi.org/project/jupyterlab-favorites)
[![conda-forge](https://img.shields.io/conda/vn/conda-forge/jupyterlab-favorites)](https://anaconda.org/conda-forge/jupyterlab-favorites)

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

![JupyterLab Favorites extension demonstration](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-favorites/master/jupyterlab-favorites.gif)

## 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

```bash
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:

```bash
jupyter labextension develop --overwrite .
```

To rebuild the extension manually after each change::

```bash
jlpm run build
```

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

```bash
jlpm run watch
```

## Older JupyterLab versions

### JupyterLab v2 Support

NPM install

```bash
jupyter labextension install jupyterlab-favorites@2.0.0
```

### Jupyterlab v1 Support

Via NPM:

```{bash}
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:

```bash
conda install -c conda-forge selenium
```

Install Pytest:

```bash
conda install -c anaconda pytest
```

Change directory to this repo after cloning

```bash
cd yourfolder/jupyterlab-favorites
```

Running test script:

```bash
./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)


