From 90498c7bf68429748a0a37e5651db7258b0fc5f8 Mon Sep 17 00:00:00 2001 From: Harry Slatyer Date: Wed, 13 Jan 2021 15:23:00 +1100 Subject: [PATCH] Add description for PyPI See https://test.pypi.org/project/M-LOOP/3.1.3/. I think it makes more sense to use a separate DESCRIPTION file instead of just the README, since the README has information about installing from source (which somebody installing from PyPI doesn't need to know about). --- DESCRIPTION.rst | 5 +++++ setup.py | 6 ++++++ 2 files changed, 11 insertions(+) create mode 100644 DESCRIPTION.rst diff --git a/DESCRIPTION.rst b/DESCRIPTION.rst new file mode 100644 index 0000000..cb528df --- /dev/null +++ b/DESCRIPTION.rst @@ -0,0 +1,5 @@ +====== +M-LOOP +====== + +The Machine-Learner Online Optimization Package is designed to automatically and rapidly optimize the parameters of a scientific experiment or computer controller system. See the documentation at http://m-loop.readthedocs.io/. diff --git a/setup.py b/setup.py index da5f11c..e84e5c0 100644 --- a/setup.py +++ b/setup.py @@ -7,8 +7,13 @@ import mloop as ml from setuptools import setup, find_packages +from os import path def main(): + this_directory = path.abspath(path.dirname(__file__)) + with open(path.join(this_directory, 'DESCRIPTION.rst'), encoding='utf-8') as f: + long_description = f.read() + setup( name = 'M-LOOP', version = ml.__version__, @@ -37,6 +42,7 @@ def main(): author = 'Michael R Hush', author_email = 'MichaelRHush@gmail.com', description = 'M-LOOP: Machine-learning online optimization package. A python package of automated optimization tools - enhanced with machine-learning - for quantum scientific experiments, computer controlled systems or other optimization tasks.', + long_description = long_description, license = 'MIT', keywords = 'automated machine learning optimization optimisation science experiment quantum', url = 'https://github.com/michaelhush/M-LOOP/',