| Name | jupyterlab-conda-store JSON |
| Version |
2024.10.1
JSON |
| download |
| home_page | None |
| Summary | A JupyterLab extension that provides a user-friendly graphical interface for building and managing environments using an existing conda-store server |
| upload_time | 2024-10-23 15:22:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2022, conda-store development team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
jupyter
jupyterlab
jupyterlab4
conda
environments
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterlab-conda-store
<div align="center">
<img src="https://raw.githubusercontent.com/conda-incubator/conda-store/main/docusaurus-docs/community/assets/logos/conda-store-logo-vertical-lockup.svg" alt="conda-store logo" width="30%">
</div>
---
| Information | Links |
| :---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Project | [](https://opensource.org/licenses/BSD-3-Clause) [][conda-store-docs] [][conda-store-ui-docs] |
| Releases |   |
---
A JupyterLab extension for [conda-store][conda-store-repo].
> [!NOTE]
> This extension is only compatible with JupyterLab `>= 4.0`.
## Installation 📦
### Pre-requisites
You will need to have [conda-store][conda-store-repo] 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:
```bash
pip install jupyterlab-conda-store
```
To remove the extension, execute:
```bash
pip uninstall jupyterlab-conda-store
```
> [!NOTE]
> Starting on version `2024.3.1`, this extension is only compatible with JupyterLab `>= 4.0`, use version `2024.1.1` for use with JupyterLab `3.x`.
## Installing the development version 🚀
### Pre-requisites
1. You will need to have [NodeJS `> 18`](https://nodejs.org/en/download/) installed on your local computer to build the extension package.
2. Python `>= 3.8` and `pip`.
### Building and linking the extension
> [!NOTE]
> 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` in the commands below.
1. Clone this repository to your local computer:
```bash
git clone https://github.com/conda-incubator/jupyterlab-conda-store.git
```
2. Change to the `jupyterlab-conda-store` directory:
```bash
cd jupyterlab-conda-store
```
3. Create a new conda environment:
```bash
conda env create -f environment.yaml
# activate the environment
conda activate jupyterlab-conda-store
```
4. Install the package in development mode:
```bash
python -m pip install -e .
```
5. Now you'll need to link the development version of the extension to JupyterLab and rebuild the Typescript source:
```bash
# Install the extension dependencies
jlpm install
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
```
6. On the first installation, or after making some changes, to visualize them in your local JupyterLab re-run the following command:
```bash
# Rebuild extension Typescript source after making changes
jlpm run build
```
7. Run JupyterLab and check that the installation worked:
```bash
# 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:
```bash
jlpm run lint:check
```
### Uninstalling the development version
1. Remove the extension:
```bash
pip uninstall jupyterlab-conda-store
```
2. In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
folder is located. Then you can remove the symlink named `jupyterlab-conda-store` within that folder.
## Release
To create a jupyterlab-conda-store release:
1. Open a `new_release` issue in the [repository][jupyterlab-conda-store-repo] and fill in the release details.
2. Follow the steps in the new release checklist.
> [!TIP]
> Follow the steps in [RELEASE.md](./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](https://github.com/conda-incubator/governance/blob/main/CODE_OF_CONDUCT.md).
## License 📃
jupyterlab-conda-store is developed under the [BSD 3-Clause License](./LICENSE).
<!-- reusable links -->
[conda-store-docs]: https://conda.store/
[conda-store-ui-docs]: https://conda-incubator.github.io/conda-store-ui/?path=/docs/welcome--docs
[conda-store-repo]: https://github.com/conda-incubator/conda-store
[jupyterlab-conda-store-repo]: https://github.com/conda-incubator/jupyterlab-conda-store
Raw data
{
"_id": null,
"home_page": null,
"name": "jupyterlab-conda-store",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Tania Allard <trallard@bitsandchips.me>",
"keywords": "Jupyter, JupyterLab, JupyterLab4, conda, environments",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d7/0f/03121ad3240eebcde9d2a3af9a23f8fe14e5709bce07d66d3c6a1cbe8c48/jupyterlab_conda_store-2024.10.1.tar.gz",
"platform": null,
"description": "# jupyterlab-conda-store\n\n<div align=\"center\">\n <img src=\"https://raw.githubusercontent.com/conda-incubator/conda-store/main/docusaurus-docs/community/assets/logos/conda-store-logo-vertical-lockup.svg\" alt=\"conda-store logo\" width=\"30%\">\n</div>\n\n---\n\n| Information | Links |\n| :---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Project | [](https://opensource.org/licenses/BSD-3-Clause) [][conda-store-docs] [][conda-store-ui-docs] |\n| Releases |   |\n\n---\n\nA JupyterLab extension for [conda-store][conda-store-repo].\n\n> [!NOTE]\n> This extension is only compatible with JupyterLab `>= 4.0`.\n\n## Installation \ud83d\udce6\n\n### Pre-requisites\n\nYou will need to have [conda-store][conda-store-repo] installed and running on your local computer to use this extension. As well as:\n\n- `JupyterLab >= 4.0`\n- Python `>= 3.8`\n\nYou can install the extension with pip:\n\n```bash\npip install jupyterlab-conda-store\n```\n\nTo remove the extension, execute:\n\n```bash\npip uninstall jupyterlab-conda-store\n```\n\n> [!NOTE]\n> Starting on version `2024.3.1`, this extension is only compatible with JupyterLab `>= 4.0`, use version `2024.1.1` for use with JupyterLab `3.x`.\n\n## Installing the development version \ud83d\ude80\n\n### Pre-requisites\n\n1. You will need to have [NodeJS `> 18`](https://nodejs.org/en/download/) installed on your local computer to build the extension package.\n2. Python `>= 3.8` and `pip`.\n\n### Building and linking the extension\n\n> [!NOTE]\n> 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` in the commands below.\n\n1. Clone this repository to your local computer:\n\n ```bash\n git clone https://github.com/conda-incubator/jupyterlab-conda-store.git\n ```\n\n2. Change to the `jupyterlab-conda-store` directory:\n\n ```bash\n cd jupyterlab-conda-store\n ```\n\n3. Create a new conda environment:\n\n ```bash\n conda env create -f environment.yaml\n\n # activate the environment\n conda activate jupyterlab-conda-store\n ```\n\n4. Install the package in development mode:\n\n ```bash\n python -m pip install -e .\n ```\n\n5. Now you'll need to link the development version of the extension to JupyterLab and rebuild the Typescript source:\n\n ```bash\n # Install the extension dependencies\n jlpm install\n # Link your development version of the extension with JupyterLab\n jupyter labextension develop . --overwrite\n ```\n\n6. On the first installation, or after making some changes, to visualize them in your local JupyterLab re-run the following command:\n\n ```bash\n # Rebuild extension Typescript source after making changes\n jlpm run build\n ```\n\n7. Run JupyterLab and check that the installation worked:\n\n ```bash\n # Run JupyterLab\n jupyter lab\n ```\n\n> [!TIP]\n> 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.\n\nTo lint files as you work on contributions, you can run:\n\n```bash\njlpm run lint:check\n```\n\n### Uninstalling the development version\n\n1. Remove the extension:\n\n ```bash\n pip uninstall jupyterlab-conda-store\n ```\n\n2. In development mode, you will also need to remove the symlink created by `jupyter labextension develop`\n command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`\n folder is located. Then you can remove the symlink named `jupyterlab-conda-store` within that folder.\n\n## Release\n\nTo create a jupyterlab-conda-store release:\n\n1. Open a `new_release` issue in the [repository][jupyterlab-conda-store-repo] and fill in the release details.\n2. Follow the steps in the new release checklist.\n\n> [!TIP]\n> Follow the steps in [RELEASE.md](./RELEASE.md) to ensure all is working as expected.\n\n## Code of Conduct \ud83e\udd1d\n\nTo guarantee a welcoming and friendly community, we require all community members to follow our [Code of Conduct](https://github.com/conda-incubator/governance/blob/main/CODE_OF_CONDUCT.md).\n\n## License \ud83d\udcc3\n\njupyterlab-conda-store is developed under the [BSD 3-Clause License](./LICENSE).\n\n<!-- reusable links -->\n\n[conda-store-docs]: https://conda.store/\n[conda-store-ui-docs]: https://conda-incubator.github.io/conda-store-ui/?path=/docs/welcome--docs\n[conda-store-repo]: https://github.com/conda-incubator/conda-store\n[jupyterlab-conda-store-repo]: https://github.com/conda-incubator/jupyterlab-conda-store\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2022, conda-store development team All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A JupyterLab extension that provides a user-friendly graphical interface for building and managing environments using an existing conda-store server",
"version": "2024.10.1",
"project_urls": {
"Homepage": "https://github.com/conda-incubator/jupyterlab-conda-store",
"Repository": "https://github.com/conda-incubator/jupyterlab-conda-store"
},
"split_keywords": [
"jupyter",
" jupyterlab",
" jupyterlab4",
" conda",
" environments"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5452939e7e76098576edb5d186cdac13312a4a295c358c804998a1c82d5f27a4",
"md5": "92727ee724d9617305a2aa0bfe175ade",
"sha256": "fa422192afd9941106d354de5cb2bea1f91fc7b8040c553df210ea865599043c"
},
"downloads": -1,
"filename": "jupyterlab_conda_store-2024.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "92727ee724d9617305a2aa0bfe175ade",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 816803,
"upload_time": "2024-10-23T15:22:44",
"upload_time_iso_8601": "2024-10-23T15:22:44.796602Z",
"url": "https://files.pythonhosted.org/packages/54/52/939e7e76098576edb5d186cdac13312a4a295c358c804998a1c82d5f27a4/jupyterlab_conda_store-2024.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d70f03121ad3240eebcde9d2a3af9a23f8fe14e5709bce07d66d3c6a1cbe8c48",
"md5": "e6f14c8e93c2c97326a93338f08153d6",
"sha256": "45e2c06b4582fad928771375d5f780fc203ec062623d7e6a67673772f8b5a255"
},
"downloads": -1,
"filename": "jupyterlab_conda_store-2024.10.1.tar.gz",
"has_sig": false,
"md5_digest": "e6f14c8e93c2c97326a93338f08153d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 573014,
"upload_time": "2024-10-23T15:22:46",
"upload_time_iso_8601": "2024-10-23T15:22:46.653395Z",
"url": "https://files.pythonhosted.org/packages/d7/0f/03121ad3240eebcde9d2a3af9a23f8fe14e5709bce07d66d3c6a1cbe8c48/jupyterlab_conda_store-2024.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 15:22:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "conda-incubator",
"github_project": "jupyterlab-conda-store",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterlab-conda-store"
}
