Skip to content
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

fix: Stop including README as top-level data file in package #296

Merged
merged 1 commit into from
May 22, 2023
Merged

fix: Stop including README as top-level data file in package #296

merged 1 commit into from
May 22, 2023

Conversation

huonw
Copy link
Contributor

@huonw huonw commented May 22, 2023 •
edited by hsluoyz
Loading

Fix: #295

Including the README.md as a top-level data file is unconventional and can interfere with other packages if they also accidentally include their README.md: installing both packages leads to the second one overwriting the README.md of 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 METADATA file.

In addition to that problem, running python setup.py bdist_wheel results in a warning, tangentially referencing this problem:

warning: install_data: setup script did not provide a directory for 'README.md' -- installing right in 'build/bdist.macosx-11.4-arm64/wheel/casbin-1.18.2.data/data'

This fixes (partially) #295, for this repository.

@casbin-bot
Copy link
Member

@Nekotoxin please review

@casbin-bot casbin-bot requested a review from Nekotoxin May 22, 2023 05:02
@CLAassistant
Copy link

CLAassistant commented May 22, 2023 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@huonw huonw mentioned this pull request May 22, 2023
Closed
@huonw huonw changed the title Stop including README as top-level data file in package fix: Stop including README as top-level data file in package May 22, 2023
@hsluoyz hsluoyz merged commit e85e9b9 into casbin:master May 22, 2023
github-actions bot pushed a commit that referenced this pull request May 22, 2023
@semantic-release-bot
chore(release): 1.18.3 [skip ci]
18ac56e 
## [1.18.3](v1.18.2...v1.18.3) (2023-05-22)

### Bug Fixes

* Exclude tests from package ([#297](#297)) ([9b014a2](9b014a2))
* Stop including README as top-level data file in package ([#296](#296)) ([e85e9b9](e85e9b9))
@github-actions
Copy link

🎉 This PR is included in version 1.18.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@huonw huonw deleted the bugfix/295-no-readme branch May 22, 2023 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Nekotoxin Nekotoxin Awaiting requested review from Nekotoxin

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

README.md file in package is installed in venv outside the package subdirectory
4 participants
@huonw @casbin-bot @CLAassistant @hsluoyz