Refactor descriptions to README.md and __summary__

This change makes it so that the __summary__ is a pydoc variable and we
can pull in the long description directly from README.md. Also add a
website url.

Change-Id: Ibab9e436d4e2c8188a456976e1ab5f19dbf88060
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>

diff --git a/MANIFEST.in b/MANIFEST.in
index a80aeab..887fa58 100644 (file)
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,3 @@
 include etc/logging.ini
+include README.md
 include requirements.txt

diff --git a/README.md b/README.md
index 920c98d..a68fe0d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,3 +3,13 @@
 This project's documentation is available on ReadTheDocs (RTD)
 
 <https://lf-releng-tools.readthedocs.io>
+
+LF Tools is a collection of scripts and utilities that are useful to Linux
+Foundation projects' CI and Releng related activities. We try to create
+these tools to be as generic as possible such that they are reusable in other
+CI environments.
+
+Ubuntu Dependencies:
+
+- build-essentials
+- python-dev

diff --git a/lftools/__init__.py b/lftools/__init__.py
index 8ced53c..77fbf1f 100644 (file)
--- a/lftools/__init__.py
+++ b/lftools/__init__.py
@@ -13,6 +13,7 @@
 """lftools package."""
 
 __author__ = 'Thanh Ha'
+__summary__ = 'Linux Foundation Release Engineering Tools'
 __version__ = '0.10.0-dev'
 
 import logging

diff --git a/setup.py b/setup.py
index 453032b..c9081c5 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -13,24 +13,9 @@
 from setuptools import find_packages
 from setuptools import setup
 
+from lftools import __summary__
 from lftools import __version__
 
-desc = '''Linux Foundation Release Engineering Tools
-Website: https://lf-releng-tools.readthedocs.io/en/latest/
-'''
-
-long_desc = '''
-LF Tools is a collection of scripts and utilities that are useful to multiple
-Linux Foundation project CI and Releng related activities. We try to create
-these tools to be as generic as possible such that they can be deployed in
-other environments.
-
-Ubuntu Dependencies:
-
-    - build-essentials
-    - python-dev
-'''
-
 with open('requirements.txt') as f:
     install_reqs = f.read().splitlines()
 
@@ -38,10 +23,10 @@ setup(
     name='lftools',
     version=__version__,
     author='Thanh Ha',
-    author_email='thanh.ha@linuxfoundation.org',
-    url='',
-    description=(desc),
-    long_description=long_desc,
+    author_email='releng@linuxfoundation.org',
+    url='https://lf-releng-tools.readthedocs.io',
+    description=__summary__,
+    long_description=open("README.md").read(),
     license='EPL',
     classifiers=[
         'Development Status :: 1 - Planning',