Merge branch 'translate-md-to-rst' of github.com:ssteinerx/django-webpack-loader into ssteinerx-translate-md-to-rst

Author: owais

.gitignore

@@ -77,3 +77,6 @@ tests/node_modules/
 tests/assets/bundles/
 tests/webpack-stats.json
 tests/webpack-stats-app2.json
+
+# PyCharm IDE
+.idea

README.md

@@ -7,15 +7,21 @@
 <br>
 Read http://owaislone.org/blog/webpack-plus-reactjs-and-django/ for a detailed step by step guide on setting up webpack with django using this library.
 
-<br>
 
 Use webpack to generate your static bundles without django's staticfiles or opaque wrappers.
 
 
 Django webpack loader consumes the output generated by [webpack-bundle-tracker](https://github.com/owais/webpack-bundle-tracker) and lets you use the generated bundles in django.
 
+## Maintainers
+In order to overcome the lack of support for Markdown on PyPi, building this package can use [pandoc](http://pandoc.org/installing.html) along with [pypandoc](https://pypi.python.org/pypi/pypandoc) to convert the README.md into a Restructured Text format compatible with PyPI. This requires installing `pandoc` for your operating system (installation instructions on the pandoc site), and `pypandoc` which will be installed if you:
+
+ pip install -r requirements-dev.txt
+ 
+before uploading to PyPI.
+
+If pandoc or pypandoc fails, the README.md file will be uploaded as it was before this enhancement.
 
-<br>
 ## Compatibility
 
 Test cases cover Django>=1.6 on Python 2.7 and Python>=3.3. 100% code coverage is the target so we can be sure everything works anytime. It should probably work on older version of django as well but the package does not ship any test cases for them.

requirements-dev.txt

@@ -3,3 +3,4 @@ Django==1.10.1
 django-jinja==2.2.1
 django-jinja2==0.1
 unittest2==1.1.0
+pypandoc==1.2.0

setup.py

@@ -8,8 +8,12 @@ def rel(*parts):
  '''returns the relative path to a file wrt to the current directory'''
  return os.path.abspath(os.path.join(os.path.dirname(__file__), *parts))
 
-with open(rel('README.md')) as handler:
- README = handler.read()
+try:
+ import pypandoc
+ README = pypandoc.convert('README.md', 'rst')
+except OSError, ImportError:
+ with open(rel('README.md')) as handler:
+ README = handler.read()
 
 with open(rel('webpack_loader', '__init__.py')) as handler:
  INIT_PY = handler.read()