From f3041ec533e85236ef2d7d9f38774b49955e404e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien?= Date: Mon, 30 Mar 2020 12:01:50 +0200 Subject: [PATCH 1/7] add placeholder sentence --- README.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.rst b/README.rst index 8f68df90..add7e032 100644 --- a/README.rst +++ b/README.rst @@ -33,6 +33,8 @@ metric-learn contains efficient Python implementations of several popular superv Run ``pip install metric-learn`` to download and install from PyPI. +Run ``TO COMPLETE`` to download and install in conda. + Run ``python setup.py install`` for default installation. Run ``pytest test`` to run all tests (you will need to have the ``pytest`` From 6195e7d47d04d67f2f96711dd0a8c096fcab039c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien?= Date: Tue, 31 Mar 2020 10:36:45 +0200 Subject: [PATCH 2/7] update setup.cfg to include license file to dist --- setup.cfg | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index 8d95aa1e..22a17139 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,4 +2,6 @@ universal = 1 [metadata] -description-file = README.rst \ No newline at end of file +description-file = README.rst +license_files = + LICENSE.txt \ No newline at end of file From 967670671a1a195bc9debc84fd1c10c91c58dd09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien?= Date: Tue, 31 Mar 2020 16:11:39 +0200 Subject: [PATCH 3/7] update README --- README.rst | 10 +++++----- setup.cfg | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index add7e032..da2a0658 100644 --- a/README.rst +++ b/README.rst @@ -31,13 +31,13 @@ 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``. -Run ``TO COMPLETE`` to download and install in conda. +- To install from PyPi: ``pip install metric-learn``. -Run ``python setup.py install`` for default installation. - -Run ``pytest test`` to run all tests (you will need to have the ``pytest`` +- For a manual install of the latest code, download the package from GitHub +and run the installer with ``python setup.py install``. You may then run +``pytest test`` to run all tests (you will need to have the ``pytest`` package installed). **Usage** diff --git a/setup.cfg b/setup.cfg index 22a17139..bc7695e3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,4 +4,4 @@ universal = 1 [metadata] description-file = README.rst license_files = - LICENSE.txt \ No newline at end of file + LICENSE.txt From 2b3614ca5f1170a2ad1fa42108a000d0cb683b8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien?= Date: Tue, 31 Mar 2020 16:15:13 +0200 Subject: [PATCH 4/7] README --- README.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index da2a0658..704637c8 100644 --- a/README.rst +++ b/README.rst @@ -31,14 +31,12 @@ metric-learn contains efficient Python implementations of several popular superv **Installation/Setup** -- If you use Anaconda: ``conda install -c conda-forge metric-learn``. +- If you use Anaconda: ``conda install -c conda-forge metric-learn``. See more +options `here `_. - To install from PyPi: ``pip install metric-learn``. -- For a manual install of the latest code, download the package from GitHub -and run the installer with ``python setup.py install``. You may then 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 package from GitHub 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** From d3dadbb6bb7476345803a8a56895c84861cccfb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien?= Date: Tue, 31 Mar 2020 16:16:09 +0200 Subject: [PATCH 5/7] README typo --- README.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 704637c8..f26c7eaf 100644 --- a/README.rst +++ b/README.rst @@ -31,8 +31,7 @@ metric-learn contains efficient Python implementations of several popular superv **Installation/Setup** -- If you use Anaconda: ``conda install -c conda-forge metric-learn``. See more -options `here `_. +- If you use Anaconda: ``conda install -c conda-forge metric-learn``. See more options `here `_. - To install from PyPi: ``pip install metric-learn``. From 46e7debb6e074975a3e1a8c6fcdb3d35624d37cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien?= Date: Tue, 31 Mar 2020 16:24:11 +0200 Subject: [PATCH 6/7] update doc --- README.rst | 2 +- doc/getting_started.rst | 11 +++++++---- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index f26c7eaf..534c43d9 100644 --- a/README.rst +++ b/README.rst @@ -35,7 +35,7 @@ metric-learn contains efficient Python implementations of several popular superv - To install from PyPi: ``pip install metric-learn``. -- For a manual install of the latest code, download the package from GitHub 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). +- 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** diff --git a/doc/getting_started.rst b/doc/getting_started.rst index 97abb9a5..00e699f9 100644 --- a/doc/getting_started.rst +++ b/doc/getting_started.rst @@ -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 `_. + +- 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** From 1f4a8a0870751f84fb6eb870e226ac4ed9e53899 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien?= Date: Tue, 31 Mar 2020 16:26:39 +0200 Subject: [PATCH 7/7] typo --- README.rst | 2 +- doc/getting_started.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 534c43d9..5afe556c 100644 --- a/README.rst +++ b/README.rst @@ -33,7 +33,7 @@ metric-learn contains efficient Python implementations of several popular superv - If you use Anaconda: ``conda install -c conda-forge metric-learn``. See more options `here `_. -- To install from PyPi: ``pip install 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). diff --git a/doc/getting_started.rst b/doc/getting_started.rst index 00e699f9..f1b35b4f 100644 --- a/doc/getting_started.rst +++ b/doc/getting_started.rst @@ -11,7 +11,7 @@ metric-learn can be installed in either of the following ways: - If you use Anaconda: ``conda install -c conda-forge metric-learn``. See more options `here `_. -- To install from PyPi: ``pip install 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).