search

springload / draftjs_exporter

Convert Draft.js ContentState to HTML
https://www.draftail.org/blog/2018/03/13/rethinking-rich-text-pipelines-with-draft-js
MIT License
83 stars 21 forks source link

Provide readme in reStructuredText format for pypi #103

Closed mojeto closed 6 years ago

mojeto commented 6 years ago

pypi project page https://pypi.org/project/draftjs_exporter/ doesn't look nice, because pypi requires package readme in reStructuredText format not markdown

thibaudcolas commented 6 years ago

@mojeto see #94, and https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi. I'm not sure why the project page doesn't look nice, but Markdown is definitely meant to be supported.

mojeto commented 6 years ago

Pypi supporting markdown is a good news to me. I'll play around with test pypi to see if I can get it work

thibaudcolas commented 6 years ago

👌

If you look at the release history, https://pypi.org/project/draftjs_exporter/2.1.1/ is when the first Markdown version of the README was used. It seems to render fine until https://pypi.org/project/draftjs_exporter/2.1.3/ – it might've been me somehow using the wrong setuptools or twine, although I have trouble understanding why.

mojeto commented 6 years ago

I can't test it on test pypi, because https://test.pypi.org/user/springload/ user isn't maintainer of the https://test.pypi.org/project/draftjs_exporter/ project. Can you please add the springload user as a maintainer on test pypi @thibaudcolas ?

thibaudcolas commented 6 years ago

@mojeto sorry about that, should be good now. I've also added @loicteixeira at the same time.

mojeto commented 6 years ago

I've build and pushed the 2.1.3 version to test pypi https://test.pypi.org/project/draftjs_exporter/2.1.3/ and it works out of the box. Using Python 3.7.0 and 

twine==1.12.1
pip==1.18.1
setuptools==40.5.0

I don't know what have changed if anything, but I've realized there is no way to upload a different package file for the same package version into pypi. So there isn't a way to fix description for current 2.1.3 version.

I'm not sure it worth creating a "test" versions of the package just to fix a description.

I'm keen to wait and see if this is still an issue for the next release.

thibaudcolas commented 6 years ago

👍 I'll troubleshoot my dev environment to make sure I have the same versions. I might have broken it when installing Python 3.7 not so long ago.

thibaudcolas commented 6 years ago

Pushed a new release to both the test and real PyPI, and all seems well 🙂 https://pypi.org/project/draftjs_exporter/.

Thanks for raising this @mojeto, it looks so much better with the proper rendering.