Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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.

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

Already on GitHub?Sign in to your account

Merged
tacaswell merged 2 commits intomatplotlib:masterfromstory645:readme
Mar 3, 2020

Conversation

story645
Copy link
Member

@story645story645 commentedMar 2, 2020
edited
Loading

PR Summary

PyPI will render readmes written inplaintext, 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.

@tacaswelltacaswell added this to thev3.2.1 milestoneMar 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)?

@story645
Copy link
MemberAuthor

story645 commentedMar 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 😓

updated project urls + longdescription to readmecomposed images from front page into one image for readmeUpdated readme for PyPa:* Updated language to match copy onhttps://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 contributionsCo-Authored-By: Thomas A Caswell <tcaswell@gmail.com>updated classifiers+ changed discourse to forum
@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.

@tacaswelltacaswell merged commit64ae323 intomatplotlib:masterMar 3, 2020
@lumberbot-app
Copy link

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 tosuggest an improvement.

@tacaswell
Copy link
Member

I have done the backport locally, will push soon.

tacaswell added a commit that referenced this pull requestMar 3, 2020
Merge pull request#16626 from story645/readmeDOC/BLD: Updated Readme + Setup.py for PyPaConflicts:README.rst         - implicitly backported several other changes to readme
@tacaswell
Copy link
Member

Manually backported via65a35ef

@story645story645 linked an issueMar 4, 2020 that may beclosed by this pull request
18 tasks
@story645story645 deleted the readme branchJune 8, 2023 17:59
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@timhoffmtimhoffmtimhoffm left review comments

@tacaswelltacaswelltacaswell approved these changes

Assignees
No one assigned
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

[8]ページ先頭

©2009-2025 Movatter.jp