Merge pull request #438 from basho/fixes/lrb/fix-pypi-documentation

Use pandoc to convert md to rst

Author: lukebakken

MANIFEST.in

@@ -2,6 +2,6 @@ include docs/*
 include riak/erl_src/*
 include README.md
 include LICENSE
-include RELEASE_NOTES.md
+include RELNOTES.md
 include version.py
 include commands.py

Makefile

@@ -1,4 +1,6 @@
-.PHONY: pb_clean pb_compile pb_build release
+.PHONY: pb_clean pb_compile pb_build release release_sdist
+
+PANDOC_VERSION := $(shell pandoc --version)
 
 clean: pb_clean
 
@@ -12,17 +14,20 @@ pb_compile: pb_clean
 	@python setup.py build_messages
 
 release_sdist:
+ifeq ($(PANDOC_VERSION),)
+	$(error The pandoc command is required to correctly convert README.md to rst format)
+endif
 ifeq ($(RELEASE_GPG_KEYNAME),)
 	$(error RELEASE_GPG_KEYNAME must be set to build a release and deploy this package)
-else
+endif
+	@python -c 'import pypandoc'
 	@echo "==> Python (sdist release)"
 	@python setup.py sdist upload -s -i $(RELEASE_GPG_KEYNAME)
-endif
 
 release: release_sdist
 ifeq ($(RELEASE_GPG_KEYNAME),)
 	$(error RELEASE_GPG_KEYNAME must be set to build a release and deploy this package)
-else
+endif
 	@echo "==> Python 2.7 (release)"
 	@python2.7 setup.py build --build-base=py-build/2.7 bdist_egg upload -s -i $(RELEASE_GPG_KEYNAME)
 	@echo "==> Python 3.3 (release)"
@@ -31,4 +36,3 @@ else
 	@python3.4 setup.py build --build-base=py-build/3.4 bdist_egg upload -s -i $(RELEASE_GPG_KEYNAME)
 	@echo "==> Python 3.5 (release)"
 	@python3.5 setup.py build --build-base=py-build/3.5 bdist_egg upload -s -i $(RELEASE_GPG_KEYNAME)
-endif

README.md

@@ -4,7 +4,7 @@ Python Client for Riak
 Documentation
 =============
 
-[Documentation for the Riak Python Client Library](http://basho.github.io/riak-python-client/index.html) is available here. The documentation source is found in [`docs/` subdirectory](https://github.com/basho/riak-python-client/tree/master/docs) and can be built with [Sphinx](http://sphinx.pocoo.org/).
+[Documentation for the Riak Python Client Library](http://basho.github.io/riak-python-client/index.html) is available [here](http://basho.github.io/riak-python-client/index.html).
 
 Documentation for Riak is available [here](http://docs.basho.com/riak/latest).
 
@@ -52,7 +52,7 @@ To setup the default test configuration build a test Riak node (from a `riak` di
 make rel
 ```
 
-See [Basic Cluster Setup](http://docs.basho.com/riak/2.0.0/ops/building/basic-cluster-setup/) for more details.
+See [Basic Cluster Setup](http://docs.basho.com/riak/latest/ops/building/basic-cluster-setup/) for more details.
 
 For all of the simple default values, set the `RIAK_DIR` environment variable to the root of your Riak installation. Then from the `riak-python-client` directory 
 
@@ -129,14 +129,14 @@ To enable the timeseries tests, set the `RUN_TIMESERIES` environment variable to
 Testing Secondary Indexes
 -------------------------
 
-To test [Secondary Indexes](http://docs.basho.com/riak/2.0.0/dev/using/2i/), the `RUN_INDEXES` environment variable must be set to 1 (or 0 to skip them.)
+To test [Secondary Indexes](http://docs.basho.com/riak/latest/dev/using/2i/), the `RUN_INDEXES` environment variable must be set to 1 (or 0 to skip them.)
 
 Testing Security (Riak 2+)
 --------------------------
 
 Ensure that the hostname `riak-test` resolves to your Riak host (most likely `localhost`). This is so the SSL host verification can succeed.
 
-By default [Security](http://docs.basho.com/riak/2.0.0beta1/ops/running/authz/) is not enabled on Riak. Once `security = on` is configured in the `riak.conf` file it can be enabled with `riak-admin`.
+By default [Security](http://docs.basho.com/riak/latest/ops/running/authz/) is not enabled on Riak. Once `security = on` is configured in the `riak.conf` file it can be enabled with `riak-admin`.
 
 To run the tests
 

setup.py

@@ -18,11 +18,16 @@
     install_requires.append('python3_protobuf >=2.4.1, <2.6.0')
     requires.append('python3_protobuf(>=2.4.1, <2.6.0)')
 
-
 tests_require = []
 if platform.python_version() < '2.7.0':
     tests_require.append("unittest2")
 
+try:
+    import pypandoc
+    long_description = pypandoc.convert('README.md', 'rst')
+except(IOError, ImportError):
+    long_description = open('README.md').read()
+
 setup(
     name='riak',
     version=get_version(),
@@ -32,6 +37,7 @@
     tests_require=tests_require,
     package_data={'riak': ['erl_src/*']},
     description='Python client for Riak',
+    long_description=long_description,
     zip_safe=True,
     options={'easy_install': {'allow_hosts': 'pypi.python.org'}},
     include_package_data=True,