Metadata-Version: 2.1
Name: envs-manager
Version: 0.1.2
Summary: A manager for Python environments and packages managers
Project-URL: Documentation, https://github.com/spyder-ide/envs-manager#readme
Project-URL: Issues, https://github.com/spyder-ide/envs-manager/issues
Project-URL: Source, https://github.com/spyder-ide/envs-manager
Author: Spyder Development Team and envs-manager contributors
Author-email: Spyder Development Team and envs-manager contributors <spyder.python@gmail.com>
License: MIT
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.7
Requires-Dist: pyyaml
Requires-Dist: requests
Provides-Extra: pre-commit
Requires-Dist: pre-commit; extra == 'pre-commit'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# envs-manager

## Project information
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/envs-manager.svg)](https://pypi.org/project/envs-manager)

[![PyPI - Version](https://img.shields.io/pypi/v/envs-manager.svg)](https://pypi.org/project/envs-manager)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/envs-manager)](https://pypi.org/project/envs-manager)

[![conda - version](https://img.shields.io/conda/vn/conda-forge/envs-manager.svg)](https://www.anaconda.org/conda-forge/envs-manager)
[![conda - Downloads](https://img.shields.io/conda/dn/conda-forge/envs-manager.svg)](https://www.anaconda.org/conda-forge/envs-manager)

## Build status
[![Windows status](https://github.com/spyder-ide/envs-manager/workflows/Windows%20tests/badge.svg)](https://github.com/spyder-ide/envs-manager/actions?query=workflow%3A%22Windows+tests%22)
[![Linux status](https://github.com/spyder-ide/envs-manager/workflows/Linux%20tests/badge.svg)](https://github.com/spyder-ide/envs-manager/actions?query=workflow%3A%22Linux+tests%22)
[![MacOS status](https://github.com/spyder-ide/envs-manager/workflows/Macos%20tests/badge.svg)](https://github.com/spyder-ide/envs-manager/actions?query=workflow%3A%22Macos+tests%22)
[![codecov](https://codecov.io/gh/spyder-ide/envs-manager/branch/main/graph/badge.svg?token=H2GZWHIL43)](https://codecov.io/gh/spyder-ide/envs-manager)

-----

**Table of Contents**

- [Installation](#installation)
    - [PyPI](#pypi)
    - [Conda](#conda)
- [Development](#development)
- [License](#license)

## Installation

### PyPI

```console
pip install envs-manager
```

### Conda

```console
conda install -c conda-forge envs-manager
```

## Development

* Fork and clone the repo. To clone:

```console
git clone <link to your fork.git>
cd envs-manager
```

* Create a Python environment and activate it. For example with conda:

```console
conda env create -n envs-manager --file requirements/environment.yml
conda activate envs-manager
```

* Install development version:

```console
pip install -e .
```

* Setup pre-commit:

```console
pre-commit install
```

* To run the test suite:

You will need to setup the `ENV_BACKEND_EXECUTABLE` environmental variable in order to use a `conda-like` manager. This environment variable should point to a conda or mamba executable. For example, if you have micromamba downloaded on Windows you should set `ENV_BACKEND_EXECUTABLE=<path to micromamba executable>/micromamba.exe`. After that you should be able to run our tests with:

```console
pytest -vv
```

* To check the command line options you need to run:

```console
envs-manager --help
```

## License

`envs-manager` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
