A JupyterLab extension that provides a user-friendly graphical interface for building and managing environments using an existing conda-store server
Project description
conda-store JupyterLab extension
A JupyterLab extension that provides a user-friendly graphical interface for building and managing environments using an instance of conda-store.
Requirements
JupyterLab >= 3.0
Install
To install the extension, execute:
pip install jupyterlab-conda-store
Uninstall
To remove the extension, execute:
pip uninstall jupyterlab-conda-store
Installing the development version
Pre-requisites
- You will need to have NodeJS installed on your local computer to build the extension package.
- Python >= 3.8 and
pip
.
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
-
Optional but recommended - Create and activate a development environment with conda:
# Create environment named `jupyterlab-conda-store` conda create -n jupyterlab-conda-store conda activate jupyterlab-conda-store
-
Install JupyterLab and NodeJS if not installed:
# Install node and jupyterlab from conda-forge conda install -c conda-forge 'nodejs>16' 'jupyterlab<4'
-
Install the package in development mode:
pip install -e .
-
Now you'll need to link the development version of the extension to JupyterLab and rebuild the Typescript source:
# 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 build
-
Run JupyterLab and check that the installation worked:
# Run JupyterLab
jupyter lab
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 new package and release:
- Bump the version in
pyproject.toml
andpackage.json
- Create a new release, and then ensure the release tag is the same as the bumped version tag.
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-2023.10.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17fe44fe998d583f1b828c5c47829d8f42af8ad541a0f794dc68565710219bbb |
|
MD5 | 4607c2382c826694c5216a746c7f3c8b |
|
BLAKE2b-256 | 1d1a027c5bacbdc2dfe106a815d672f248b5261b1fdcc57bba51869b13eacbc6 |
Hashes for jupyterlab_conda_store-2023.10.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 97ae159707472b6eb14e7eca16d44d6aa80e9cddb893a3c001f405aa04a6f447 |
|
MD5 | 6565cf96137791d416288eb7c568fd71 |
|
BLAKE2b-256 | f684c84f846f149c2d01d0817a33dbd42ef10846012280ce39a4209d709867df |