setup.py, README: Generate proper Project Description for PyPi #802
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jelmer
approved these changes
Feb 23, 2022
jelmer
reviewed
Feb 23, 2022
|
On Wed, Feb 23, 2022 at 01:45:26PM -0800, ix5 wrote:
@ix5 commented on this pull request.
> @@ -9,7 +9,7 @@ Python and JavaScript. It aims to be a drop-in replacement for
See [posativ.org/isso](http://posativ.org/isso/) for more details.
## License
-MIT, see [LICENSE](LICENSE).
+MIT, see [LICENSE](https://github.com/posativ/isso/blob/master/LICENSE).
You cannot link to package resources inside PyPi, even if you include them in `MANIFEST.in`.
(I tested via https://test.pypi.org/project/isso-testpypi/ and the link goes to a 404, as you'd expect: https://test.pypi.org/project/isso-testpypi/LICENSE )
I don't think we should bother fixing it then; ideally we'd just filter out the entire license section since the license is already shown on the left hand side on Pypi.
|
This allows for more information by embedding the README at https://pypi.org/project/isso/ as a "Project Description".
The LICENSE link is a repo-relative one that will 404 if rendered on PyPi. Filter it out since PyPi already has license info in its sidebar. Yes, this is a very brittle solution, but maintainers should not have to upload too often.
ix5
force-pushed
the
feature/setup-long_desc
branch
from
7ed8868 to
09f930c
Compare
Done. Personally, I think this is the ugliest code I've ever committed, but I agree with your sentiment. Unless someone comes up with a better/cleaner/more beautiful solution, I'm merging this within 2 days. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
setup.py: Include README in pypi upload
This allows for more information by embedding the README at https://pypi.org/project/isso/ as a "Project Description".
README:
Point LICENSE to current GH master,shuffle sections a bitReasoning: Use absolute link to allow embedding the rendered README on pypi (where the relative-path LICENSE is not available).