fix formatting description on PyPi

The package description on PyPi is based on now based on the README.md file, but PyPi only likes the rst format. There is a very elegant solution for that on StackOverflow here. However, this doesn't work because the long_description field is being overwritten by PBR (docs) which is used by PyScaffold. This one is based on README.md.

So either we figure out how to make sure PyScaffold/PBR use the long_description we define, or move formatting back to rst. Since I like md more than rst, I prefer to the former.

Started branch 22-fix-formatting-description-on-pypi

Will this commit fix it c3b8c795

I already tried that, but it didn't work. You can check if you open the packaged file and open the PKG-INFO file. The description value should contain the rst formatted README.md contents.

packaged file meaning the result of python setup.py bdist_wheel or python setup.py sdist.

When I make the wheel now, the file WindEnergyToolbox\dist\wetb-0.0.6.post0.dev1+ngb2adec10.dirty-cp35-cp35m-win_amd64.whl\wetb-0.0.6.post0.dev1+ngb2adec10.dirty.dist-info\DESCRIPTION.rst is a rst formatted copy of the read me file

but pypandoc is required (required dependencies + installation guide???)

for the record, here's a SO answer with a workaround: http://stackoverflow.com/questions/10718767/have-the-same-readme-both-in-markdown-and-restructuredtext

@dave is it working for you also?

As far as I remember, I had to pip install pypandoc - is it correct, that there is no conda package for windows?

there is a conda package, it is just called pandoc instead of pypandoc. I included this in the dev-guide.

Yes, but that is not the same. pypandoc is a package on top of pandoc, and convert_file is part of pypandoc (https://pypi.python.org/pypi/pypandoc). But it can be installed from conda-forge conda install -c conda-forge pypandoc

aaah, I was too fast, sorry :-) I'll add it to the docs! Thanks for pointing this out.

I hope it is fixed now, see 08dd2952! Thanks for reviewing this, I think this is really helpful!

I think this is better: 1eabdb0b

This is fixed now (916339b8). Note that uploading the wheel packages with twine files for me (source and linux wheels, not the windows wheel strange enough), but manually uploading packages on pypi does work.

closed