search

rossant / ipycache

Defines a %%cache cell magic in the IPython notebook to cache results of long-lasting computations in a persistent pickle file
BSD 3-Clause "New" or "Revised" License
139 stars 35 forks source link

Package the License and Readme #45

Closed jakirkham closed 2 years ago

jakirkham commented 7 years ago

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

jakirkham commented 7 years ago

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 commented 7 years ago

cc @jochym

mbrukman commented 2 years ago

@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 https://github.com/rossant/ipycache/issues/69 to migrate setup.py to setup.cfg and also https://github.com/rossant/ipycache/issues/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 commented 2 years ago

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! 🙏