Merge pull request #679 from graingert/verify-readme-rst-pypi

verify readme for PyPI

MANIFEST.in

@@ -0,0 +1,4 @@
+include README.rst
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

README.rst

@@ -1,5 +1,5 @@
 Sanic
-=================================
+=====
 
 |Join the chat at https://gitter.im/sanic-python/Lobby| |Build Status| |PyPI| |PyPI version|
 
@@ -86,8 +86,9 @@ Documentation
 
 TODO
 ----
-* Streamed file processing
-* http2
+ * Streamed file processing
+ * http2
+
 Limitations
 -----------
 * No wheels for uvloop and httptools on Windows :(

setup.py

@@ -9,14 +9,27 @@ from distutils.util import strtobool
 
 from setuptools import setup
 
-with codecs.open(os.path.join(os.path.abspath(os.path.dirname(
-        __file__)), 'sanic', '__init__.py'), 'r', 'latin1') as fp:
+
+def open_local(paths, mode='r', encoding='latin1'):
+    path = os.path.join(
+        os.path.abspath(os.path.dirname(__file__)),
+        *paths
+    )
+
+    return codecs.open(path, mode, encoding)
+
+
+with open_local(['sanic', '__init__.py']) as fp:
     try:
         version = re.findall(r"^__version__ = '([^']+)'\r?$",
                              fp.read(), re.M)[0]
     except IndexError:
         raise RuntimeError('Unable to determine version.')
 
+
+with open_local(['README.rst']) as rm:
+    long_description = rm.read()
+
 setup_kwargs = {
     'name': 'sanic',
     'version': version,
@@ -26,6 +39,7 @@ setup_kwargs = {
     'author_email': 'channelcat@gmail.com',
     'description': (
         'A microframework based on uvloop, httptools, and learnings of flask'),
+    'long_description': long_description,
     'packages': ['sanic'],
     'platforms': 'any',
     'classifiers': [

tox.ini

@@ -1,11 +1,11 @@
 [tox]
-envlist = py35, py36, flake8
+envlist = py35, py36, flake8, check
 
 
 [travis]
 python =
-    3.5: py35, flake8
-    3.6: py36, flake8
+    3.5: py35, flake8, check
+    3.6: py36, flake8, check
 
 
 [testenv]
@@ -24,3 +24,10 @@ deps =
 
 commands =
     flake8 sanic
+
+[testenv:check]
+deps =
+    docutils
+    pygments
+commands =
+    python setup.py check -r -s