A JupyterLab extension that provides a user-friendly graphical interface for building and managing environments using an existing conda-store server
Project description
jupyterlab-conda-store
Information | Links |
---|---|
Project | |
Releases |
A JupyterLab extension for conda-store.
[!NOTE] This extension is only compatible with JupyterLab
>= 4.0
.
Installation 📦
Pre-requisites
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
[!NOTE] Starting on version
2024.3.1
, this extension is only compatible with JupyterLab>= 4.0
, use version2024.1.1
for use with JupyterLab3.x
.
Installing the development version 🚀
Pre-requisites
- You will need to have NodeJS
> 18
installed on your local computer to build the extension package. - Python
>= 3.8
andpip
.
Building and linking the extension
[!NOTE] The
jlpm
command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may useyarn
ornpm
in lieu ofjlpm
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.yaml # 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
Uninstalling the development version
-
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.
Release
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.
Code of Conduct 🤝
To guarantee a welcoming and friendly community, we require all community members to follow our Code of Conduct.
License 📃
jupyterlab-conda-store is developed under the BSD 3-Clause License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyterlab_conda_store-2024.10.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45e2c06b4582fad928771375d5f780fc203ec062623d7e6a67673772f8b5a255 |
|
MD5 | e6f14c8e93c2c97326a93338f08153d6 |
|
BLAKE2b-256 | d70f03121ad3240eebcde9d2a3af9a23f8fe14e5709bce07d66d3c6a1cbe8c48 |
Hashes for jupyterlab_conda_store-2024.10.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa422192afd9941106d354de5cb2bea1f91fc7b8040c553df210ea865599043c |
|
MD5 | 92727ee724d9617305a2aa0bfe175ade |
|
BLAKE2b-256 | 5452939e7e76098576edb5d186cdac13312a4a295c358c804998a1c82d5f27a4 |