search

pazz / urwidtrees

tree widgets for urwid
GNU General Public License v3.0
52 stars 18 forks source link

add long_description to setup.py for a nice representation on pypi #38

Closed knoppo closed 7 years ago

knoppo commented 7 years ago

Show the README.md on the urwidtrees pypi page

https://pypi.python.org/pypi/urwidtrees/

lucc commented 7 years ago

does pypi render the markdown for us?

knoppo commented 7 years ago

Yes it should. They had security issues with this and removed it some time ago but its working again. Example: https://pypi.python.org/pypi/django-registration

Edit: Well, now I'm not so sure anymore... :( It seems to work with most repositories Edit2: It supports rst, so most markdown works: https://pypi.python.org/pypi/django-registration-bootstrap Even psycopg2 does it as you can see in its setup.py: https://pypi.python.org/pypi/psycopg2

knoppo commented 7 years ago

So, I digged a bit into it: http://stackoverflow.com/questions/26737222/pypi-description-markdown-doesnt-work As long as the markdown contains only elements from both (md and rst) it will work but I wouldn't recommend it for markdown anymore.