Skip to content

Commit 8a02af7

Browse files
authored
[MRG] Allow installation from conda (#283)
* add placeholder sentence * update setup.cfg to include license file to dist * update README * README * README typo * update doc * typo
1 parent a748c07 commit 8a02af7

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

README.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,11 @@ metric-learn contains efficient Python implementations of several popular superv
3131

3232
**Installation/Setup**
3333

34-
Run ``pip install metric-learn`` to download and install from PyPI.
34+
- 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>`_.
3535

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

38-
Run ``pytest test`` to run all tests (you will need to have the ``pytest``
39-
package installed).
38+
- 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).
4039

4140
**Usage**
4241

doc/getting_started.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,15 @@ Getting started
55
Installation and Setup
66
======================
77

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

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

12-
- ``python setup.py install`` for default installation.
13-
- ``pytest test`` to run all tests.
12+
- 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>`_.
13+
14+
- To install from PyPI: ``pip install metric-learn``.
15+
16+
- 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).
1417

1518
**Dependencies**
1619

setup.cfg

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
universal = 1
33

44
[metadata]
5-
description-file = README.rst
5+
description-file = README.rst
6+
license_files =
7+
LICENSE.txt

0 commit comments

Comments
 (0)