Information | Links |
---|---|
Project | |
Workflows | |
Releases |
A JupyterLab extension for conda-store.
Note
This extension is only compatible with JupyterLab >= 4.0
.
You will need to have conda-store installed and running on your local computer to use this extension. As well as:
JupyterLab >= 4.0
- Python
>= 3.8
You can install the extension with pip:
pip install jupyterlab-conda-store
To remove the extension, execute:
pip uninstall jupyterlab-conda-store
- You will need to have NodeJS
> 18
installed on your local computer to build the extension package. - Python
>= 3.8
andpip
.
Note
The jlpm
command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may useyarn
or npm
in lieu of jlpm
in the commands below.
-
Clone this repository to your local computer:
git clone https://github.com/conda-incubator/jupyterlab-conda-store.git
-
Change to the
jupyterlab-conda-store
directory:cd jupyterlab-conda-store
-
Create a new conda environment:
conda env create -f environment.yml # activate the environment conda activate jupyterlab-conda-store
-
Install the package in development mode:
python -m pip install -e .
-
Now you'll need to link the development version of the extension to JupyterLab and rebuild the Typescript source:
# Install the extension dependencies jlpm install # Link your development version of the extension with JupyterLab jupyter labextension develop . --overwrite
-
On the first installation, or after making some changes, to visualize them in your local JupyterLab re-run the following command:
# Rebuild extension Typescript source after making changes jlpm run build
-
Run JupyterLab and check that the installation worked:
# Run JupyterLab jupyter lab
Tip
At times you might need to clean your local repo with the command npm run clean:slate
. This will clean the repository, and re-install and rebuild.
To lint files as you work on contributions, you can run:
jlpm run lint:check
-
Remove the extension:
pip uninstall jupyterlab-conda-store
-
In development mode, you will also need to remove the symlink created by
jupyter labextension develop
command. To find its location, you can runjupyter labextension list
to figure out where thelabextensions
folder is located. Then you can remove the symlink namedjupyterlab-conda-store
within that folder.
To create a jupyterlab-conda-store release:
- Open a
new_release
issue in the repository and fill in the release details. - Follow the steps in the new release checklist.
Tip
Follow the steps in RELEASE.md to ensure all is working as expected.
To guarantee a welcoming and friendly community, we require all community members to follow our Code of Conduct.
jupyterlab-conda-store is developed under the BSD 3-Clause License.