Updated Readme + Setup.py for PyPa#16626
Conversation
|
Is there anyway to check how pypi is going to interpret the updated strings (short of releasing as seeing what it does)? |
|
@tacaswell apparently yes: https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup ETA1 I think I'm accidentally gonna learn about packaging 😅 Now to figure out how to automate that 😓 |
updated project urls + longdescription to readme composed images from front page into one image for readme Updated readme for PyPa: * Updated language to match copy on https://matplotlib.org/devdocs/ * Added logo + front page images * removed link to developer notes since ended up not using that * removed link to gitwash generated docs since they're not very good * used python -mpytest language since it's more robust * updated testing link and shortened to one option * moved contact down 'cause on pypa that information is in the sidebar & for other folks reading the readme they're probably looking for contributions Co-Authored-By: Thomas A Caswell <[email protected]> updated classifiers+ changed discourse to forum
|
I'm going to merge this and then manually do the backport so I can (finally) get the 3.2.0 tag done. |
|
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon! If these instruction are inaccurate, feel free to suggest an improvement. |
|
I have done the backport locally, will push soon. |
Merge pull request #16626 from story645/readme DOC/BLD: Updated Readme + Setup.py for PyPa Conflicts: README.rst - implicitly backported several other changes to readme
|
Manually backported via 65a35ef |
3 participants
PR Summary
PyPI will render readmes written in plaintext, markdown or rst , so wanted to take advantage of that since the current mpl page is kind of sparse: https://pypi.org/project/matplotlib/
While updating the readme & setup.py for pictures (logo and a grainy version of the frontpage quartet - would love some help here to improve it), I also added the discourse and funding links in setup.py (project urls are fluid & updated some of the readme links 'cause the old references had been moved. Also shortened and moved around some content to try and make the readme a bit concise.
This is also sort of a model for what packages should do if #16592 goes in.