Metadata-Version: 2.4
Name: mamba_gator
Version: 6.1.1
Summary: Manage your conda environments
Author: Continuum Analytics, Jupyter Development Team
License: Copyright (c) 2016 Continuum Analytics, Inc. and contributors
        Copyright (c) 2018-2020 Frederic Collonval
        All rights reserved. 
        
        Redistribution and use in source and binary forms, with or without modification,
        are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.
        
        * 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.
        
        * Neither the name of Continuum Analytics nor the names of any 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 OWNER 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.
License-File: LICENSE
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: jupyter-client
Requires-Dist: jupyter-server<3.0.0,>=2.0.0
Requires-Dist: jupyterlab-server<3.0.0,>=2.0.0
Requires-Dist: jupyterlab<5.0.0,>=4.0.0
Requires-Dist: packaging
Requires-Dist: pip
Requires-Dist: tornado
Requires-Dist: traitlets
Provides-Extra: dev
Requires-Dist: hatch; extra == 'dev'
Provides-Extra: docs
Requires-Dist: linkify-it-py; extra == 'docs'
Requires-Dist: myst-parser; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-book-theme; extra == 'docs'
Requires-Dist: sphinx-design; extra == 'docs'
Provides-Extra: test
Requires-Dist: coverage; extra == 'test'
Requires-Dist: flake8; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-jupyter[server]>=0.11.0; extra == 'test'
Description-Content-Type: text/markdown

# Gator

The Mamba Navigator, a Web UI for managing conda environments

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mamba-org/gator/main?urlpath=lab)
[![conda-forge version](https://img.shields.io/conda/vn/conda-forge/mamba_gator?logo=conda-forge)](https://anaconda.org/conda-forge/mamba_gator)
[![anaconda version](https://img.shields.io/conda/vn/anaconda/mamba_gator?logo=anaconda)](https://anaconda.org/anaconda/mamba_gator)
[![Github Actions Status](https://github.com/mamba-org/gator/workflows/Test/badge.svg)](https://github.com/mamba-org/gator/actions?query=workflow%3ATest)
[![Swagger Validator](https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Fraw.githubusercontent.com%2Fmamba-org%2Fgator%2Fmain%2Fmamba_gator%2Frest_api.yml)](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/mamba-org/gator/main/mamba_gator/rest_api.yml)

Provides Conda/Mamba environment and package management as a [standalone application](#Navigator) or as extension for [JupyterLab](#JupyterLab).

## Install

_Requirements_

- conda >= 4.7.12 or mamba >= 1.0 (mamba 2.x also works)
- JupyterLab >= 4.0 (for the JupyterLab extension only)

> This extension will use [mamba](https://github.com/mamba-org/mamba) instead of `conda` if it finds it.

To install in the JupyterLab:

```shell
mamba install -c conda-forge jupyterlab mamba_gator
```

> Optionally, you could install [`jupyterlab-tour`](https://github.com/jupyterlab-contrib/jupyterlab-tour) to
> add a help tour for the conda packages manager.

## JupyterLab

This extension adds a new entry _Conda Packages Manager_ in the _Settings_ menu.

> The first time, it can take quite some time to build the available packages list. But once it is obtained,
> it will be cached and updated to the background to have a smoother user experience.

![jupyterlab_conda_extension](packages/labextension/jupyterlab_conda.gif)

## _Gator_ (Mamba navigator)

This project contains a standalone navigator application sharing much of the code
of the JupyterLab extension.

## Creating New Environments

There are three ways to create an environment:

- Create a new environment
  Use the New Environment button at the top of the page, and select `Python 3`, or `R` to create a
  base environment with the corresponding packages. Note that if you want to run a
  Jupyter python kernel in the new environment, you must also install the `ipykernel`
  package in the environment.

- Clone an existing environment
  Click the clone button next to an environment in the list, and enter the desired name of the
  new environment.

- Import an exported environment from a YAML file

### Try it online

Open _Gator_ (Mamba Navigator): [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mamba-org/gator/main?urlpath=mamba/gator)

Open JupyterLab: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mamba-org/gator/main?urlpath=lab)

![lab-launcher](packages/navigator/navigator_as_service.png)

## Development

To setup a development environment follow our [Contributing Guide](CONTRIBUTING.md).

If you would like to try a pre-release version:

```shell
conda create -c conda-forge -y -n gator python=3.14 nodejs jupyterlab=4.0
conda activate gator
pip install git+https://github.com/mamba-org/gator.git
jupyter lab
```

## Acknowledgements

This work started as a fork by [@fcollonval](https://github.com/fcollonval/) of the Anaconda [nb_conda package](https://github.com/Anaconda-Platform/nb_conda) to add
JupyterLab support.

Then with the [mamba initiative](https://medium.com/@QuantStack/open-software-packaging-for-science-61cecee7fc23) pushed by QuantStack it made
sense to move the project in the `mamba-org` organization.

## Changelog

- [Changelog file](docs/source/changelog.md) (in this repository)
- [Rendered documentation](https://mamba-gator.readthedocs.io/en/latest/changelog.html)
