README.md must be reStructuredText (README.rst) for PyPI

[bittner]

The current README is not displayed correctly on PyPI. The reason is that PyPI expects reStructuredText, which it then converts to HTML.

You'll have to refactor your README.md to README.rst. Not a big deal, but it should be done (also the two first images being referred to don't exist any more, or the URL is broken).

[bittner]

Alternatively, you can use pypandoc to convert README.md to reStructuredText on-the-fly when creating and uploading a dist.

# -- FILE: setup.py
from pypandoc import convert

setup(
    name='cmsplugin-forms-builder',
    # ...
    # generate reStructuredText upon `python setup.py sdist upload`:
    long_description=convert('README.md', 'rst'),
)

See djangocms-cascade (setup.py) for a working example.

[ericamador]

Thanks for the recommendation. I'll test out pypandoc with the next release.