fix: Stop including README as top-level data file in package #63
Conversation
This file contains 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
|
@Nekotoxin please review |
|
|
hsluoyz
changed the title
github-actions bot
pushed a commit
that referenced
this pull request
May 22, 2023
## [0.5.2](v0.5.1...v0.5.2) (2023-05-22) ### Bug Fixes * Stop including README as top-level data file in package ([#63](#63)) ([206be72](206be72))
|
🎉 This PR is included in version 0.5.2 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Including the
README.mdas a top-level data file is unconventional and can interfere with other packages if they also accidentally include theirREADME.md: installing both packages leads to the second one overwriting theREADME.mdof the first one. (A lot of the casbin python packages interfere with each other like this.)The contents of the README is available as the package's long description, which is included in its
METADATAfile.In addition to that problem, running
python setup.py bdist_wheelresults in a warning, tangentially referencing this problem:This fixes (partially) casbin/pycasbin#295, for this repository.