Use README as project long description on PyPI.

pekkaklarck · pekkaklarck · commit 8cb99a57282c · 2014-09-26T11:54:44.000+03:00
setup.py can otherwise use README as-is, but relative INSTALL.rst link is changed to an absolute URL. Resolves robotframework#1789.
diff --git a/README.rst b/README.rst
@@ -1,13 +1,6 @@
 Robot Framework
 ===============
 
-.. note::  This repository is currently under migration from `Google Code`__.
-           Code and issues have already been moved, but it will take some tim
-           before `old wiki pages`__ are migrated.
-
-__ http://code.google.com/p/robotframework/
-__ http://code.google.com/p/robotframework/wiki/DocumentationIndex?tm=6
-
 Introduction
 ------------
 
@@ -29,11 +22,12 @@ http://robotframework.org.
 
 Robot Framework project is hosted on GitHub_ where you can find source code,
 an issue tracker, and some further documentation.  Downloads are hosted at
-PyPI_, except for the standalone jar distribution that is in `Maven central`_.
+PyPI_, except for the standalone JAR distribution that is in `Maven central`_.
 
 .. _GitHub: https://github.com/robotframework/robotframework
 .. _PyPI: https://pypi.python.org/pypi/robotframework
 .. _Maven central: http://search.maven.org/#search%7Cga%7C1%7Ca%3Arobotframework
+.. _pip: http://pip-installer.org
 
 Installation
 ------------
@@ -49,11 +43,9 @@ install the framework with::
     python setup.py install
 
 For more detailed installation instructions, including installing
-Python, Jython and IronPython, see `INSTALL.rst`_.
+Python, Jython and IronPython, see `<INSTALL.rst>`__.
 
-.. Using an absolute URL here to make this work also on PyPI.
-.. _INSTALL.rst: https://github.com/robotframework/robotframework/blob/master/INSTALL.rst
-.. _pip: http://pip-installer.org
+.. setup.py replaces the above `<INSTALL.rst>`__ with an absolute URL
 
 Example
 -------
diff --git a/setup.py b/setup.py
@@ -2,16 +2,30 @@
 
 import sys
 import os
-from os.path import join, dirname
+from os.path import abspath, join, dirname
 from distutils.core import setup
 
 if 'develop' in sys.argv or 'bdist_wheel' in sys.argv:
     import setuptools    # support setuptools development mode and wheels
 
-execfile(join(dirname(__file__), 'src', 'robot', 'version.py'))
+CURDIR = dirname(abspath(__file__))
 
+execfile(join(CURDIR, 'src', 'robot', 'version.py'))
+VERSION = get_version(sep='')
+with open(join(CURDIR, 'README.rst')) as readme:
+    install = 'https://github.com/robotframework/robotframework/blob/master/INSTALL.rst'
+    LONG_DESCRIPTION = readme.read().replace(
+        '`<INSTALL.rst>`__', '`INSTALL.rst <%s>`__' % install)
+CLASSIFIERS = """
+Development Status :: 5 - Production/Stable
+License :: OSI Approved :: Apache Software License
+Operating System :: OS Independent
+Programming Language :: Python
+Topic :: Software Development :: Testing
+""".strip().splitlines()
+KEYWORDS = 'robotframework testing testautomation acceptancetesting atdd bdd'
 # Maximum width in Windows installer seems to be 70 characters -------|
-DESCRIPTION = """
+WINDOWS_DESCRIPTION = """
 Robot Framework is a generic test automation framework for acceptance
 testing and acceptance test-driven development (ATDD). It has
 easy-to-use tabular test data syntax and utilizes the keyword-driven
@@ -20,13 +34,6 @@
 new keywords from existing ones using the same syntax that is used for
 creating test cases.
 """.strip()
-CLASSIFIERS = """
-Development Status :: 5 - Production/Stable
-License :: OSI Approved :: Apache Software License
-Operating System :: OS Independent
-Programming Language :: Python
-Topic :: Software Development :: Testing
-""".strip().splitlines()
 PACKAGES = ['robot', 'robot.api', 'robot.conf',
             'robot.htmldata', 'robot.libdocpkg', 'robot.libraries',
             'robot.model', 'robot.output', 'robot.parsing',
@@ -47,18 +54,19 @@
     SCRIPTS = [s+'.bat' for s in SCRIPTS]
 if 'bdist_wininst' in sys.argv:
     SCRIPTS.append('robot_postinstall.py')
+    LONG_DESCRIPTION = WINDOWS_DESCRIPTION
 
 setup(
     name         = 'robotframework',
-    version      = get_version(sep=''),
+    version      = VERSION,
     author       = 'Robot Framework Developers',
     author_email = 'robotframework@gmail.com',
     url          = 'http://robotframework.org',
     download_url = 'https://pypi.python.org/pypi/robotframework',
     license      = 'Apache License 2.0',
     description  = 'A generic test automation framework',
-    long_description = DESCRIPTION,
-    keywords     = 'robotframework testing testautomation atdd bdd',
+    long_description = LONG_DESCRIPTION,
+    keywords     = KEYWORDS,
     platforms    = 'any',
     classifiers  = CLASSIFIERS,
     package_dir  = {'': 'src'},
