Skip to content

Updated Readme + Setup.py for PyPa #16626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Mar 3, 2020
Merged

Updated Readme + Setup.py for PyPa #16626

merged 2 commits into from
Mar 3, 2020

Conversation

story645
Copy link
Member

@story645 story645 commented Mar 2, 2020 •
edited
Loading

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.

@tacaswell tacaswell added this to the v3.2.1 milestone Mar 2, 2020
@tacaswell
Copy link
Member

Is there anyway to check how pypi is going to interpret the updated strings (short of releasing as seeing what it does)?

tacaswell
tacaswell reviewed Mar 2, 2020
View reviewed changes
@story645
Copy link
Member Author

story645 commented Mar 2, 2020 •
edited
Loading

@tacaswell apparently yes: https://packaging.python.org/guides/making-a-pypi-friendly-readme/#validating-restructuredtext-markup

twine check dist/*

ETA1 I think I'm accidentally gonna learn about packaging 😅
ETA2:

Checking dist\matplotlib-3.2.0rc2+1618.g1f13cc811.tar.gz: PASSED

Now to figure out how to automate that 😓

@story645
added logo to readme and changed contrib link to contribute page
62cfa1a 
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 <tcaswell@gmail.com>

updated classifiers+ changed discourse to forum
@tacaswell tacaswell modified the milestones: v3.2.1, v3.2.0 Mar 3, 2020
timhoffm
timhoffm reviewed Mar 3, 2020
View reviewed changes
@tacaswell
Copy link
Member

I'm going to merge this and then manually do the backport so I can (finally) get the 3.2.0 tag done.

@tacaswell tacaswell merged commit 64ae323 into matplotlib:master Mar 3, 2020
@lumberbot-app
Copy link

lumberbot-app bot commented Mar 3, 2020

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
$ git checkout v3.2.x
$ git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
$ git cherry-pick -m1 64ae32323f9d997c00bf36326dc1d4196618c7b1
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #16626: Updated Readme + Setup.py for PyPa'
  1. Push to a named branch :
git push YOURFORK v3.2.x:auto-backport-of-pr-16626-on-v3.2.x
  1. Create a PR against branch v3.2.x, I would have named this PR:

"Backport PR #16626 on branch v3.2.x"

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.

@tacaswell
Copy link
Member

I have done the backport locally, will push soon.

tacaswell added a commit that referenced this pull request Mar 3, 2020
@tacaswell
Backport PR #16626: Updated Readme + Setup.py for PyPa
65a35ef 
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
@tacaswell
Copy link
Member

Manually backported via 65a35ef

@story645 story645 linked an issue Mar 4, 2020 that may be closed by this pull request
Move keeping track of 3rd party packages to pypa/conda #16592
Closed
18 tasks
@story645 story645 deleted the readme branch June 8, 2023 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm left review comments

@tacaswell tacaswell tacaswell approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.2.0
Development

Successfully merging this pull request may close these issues.

Move keeping track of 3rd party packages to pypa/conda
3 participants
@story645 @tacaswell @timhoffm