add a README for wheels #504
Merged
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.
Wheel-building CI jobs are failing like this:
(build link)
Looks like the root cause is a combination of the following:
twinerelease (6.x) 3 days ago: https://pypi.org/project/twine/#historytwine check --strictfail if the wheel'slong_descriptionis emptycuvswheel README (used as the wheellong_description) is emptyThis proposes adding a small README, with just 2 sentences copied from the project's root-level README, to get past that check.
Notes for Reviewers
The
long_descriptionbecomes the project homepage when a project is hosted on PyPI. The wheels produced from this repo aren't currently being published to pypi.org so this change won't be seen there, but a more user-friendly README should be added if/when we decide to publishcuvs-cu{11,12}to pypi.org.ref: rapidsai/build-planning#70