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.

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

Package the License and Readme #45

Closed
wants to merge 1 commit into from

Conversation

jakirkham
Copy link

Add the License the Readme to MANIFEST.in so that they are included in sdists and related packages.

@jakirkham
Copy link
Author

Failure is related to the fact that the --use-mirrors option has been dropped from pip and thus is orthogonal to this change and is present in master already.

@jakirkham
Copy link
Author

cc @jochym

@mbrukman
Copy link
Collaborator

@jakirkham — thanks for putting this PR together!

Is packaging the README necessary anymore? It appears it's already included by default: https://packaging.python.org/en/latest/guides/using-manifest-in/#using-manifest-in

Also, I understand that MANIFEST.in is not necessarily used anymore (and per docs, it's removed from a sample project config).

I filed #69 to migrate setup.py to setup.cfg and also #70 to package the license file in the setup.cfg and assigned both of them to myself, so please feel free to close this PR and subscribe to either (or both) of those issues to follow the status of this work.

@jakirkham
Copy link
Author

Yes thankfully the tooling has improved to make packaging license files easier.

The README is nice to have, but no don't think it is critically needed.

Will go ahead and close this out. Thanks for taking all of this on! 🙏

@jakirkham jakirkham closed this Jan 19, 2022
@jakirkham jakirkham deleted the make_manifest branch January 19, 2022 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants