Skip to content

[MRG] Allow installation from conda #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,11 @@ metric-learn contains efficient Python implementations of several popular superv

**Installation/Setup**

Run ``pip install metric-learn`` to download and install from PyPI.
- If you use Anaconda: ``conda install -c conda-forge metric-learn``. See more options `here <https://github.com/conda-forge/metric-learn-feedstock#installing-metric-learn>`_.

Run ``python setup.py install`` for default installation.
- To install from PyPI: ``pip install metric-learn``.

Run ``pytest test`` to run all tests (you will need to have the ``pytest``
package installed).
- For a manual install of the latest code, download the source repository and run ``python setup.py install``. You may then run ``pytest test`` to run all tests (you will need to have the ``pytest`` package installed).

**Usage**

Expand Down
11 changes: 7 additions & 4 deletions doc/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ Getting started
Installation and Setup
======================

Run ``pip install metric-learn`` to download and install from PyPI.
**Installation**

Alternately, download the source repository and run:
metric-learn can be installed in either of the following ways:

- ``python setup.py install`` for default installation.
- ``pytest test`` to run all tests.
- If you use Anaconda: ``conda install -c conda-forge metric-learn``. See more options `here <https://github.com/conda-forge/metric-learn-feedstock#installing-metric-learn>`_.

- To install from PyPI: ``pip install metric-learn``.

- For a manual install of the latest code, download the source repository and run ``python setup.py install``. You may then run ``pytest test`` to run all tests (you will need to have the ``pytest`` package installed).

**Dependencies**

Expand Down
4 changes: 3 additions & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@
universal = 1

[metadata]
description-file = README.rst
description-file = README.rst
license_files =
LICENSE.txt