PAIR-code
Docs/Meta for Packagers: Packaging info on PyPI, tags for patches
I'm representing TF SIG Build, a TensorFlow special interest group dedicated to building and testing TF in open source. Our last meeting surfaced confusion from community members involved in packaging TF for other environments (e.g. Gentoo, Anaconda) about tensorboard-plugin-wit, which I think could be resolved with these two asks:
- Could the PyPI page be updated to answer these questions? Our packagers only know about WIT from the indirect
tensorflow->tensorboard->tensorflow-plugin-witdependency, which points to an empty PyPI page.- What does the plugin do? (e.g. a short description and links to the canonical WIT site)
- Why does
tensorboarddepend on it? (e.g. "it was once part of core tensorboard but was moved to a plugin") - Where is the source code, and how is it built? (i.e. this repo)
- Could we have assurance that future PyPI releases match up with a tag from a Git source? In this case, the
1.6.0post*patch releases lack a matching tag in this repo. For packagers, a tag for each release means they can rebuild the package in the necessary configuration for their platform, and helps verify that the package on PyPI really matches up with the code.
These would help a lot!
Thanks @angerson . I just put up https://github.com/PAIR-code/what-if-tool/pull/109 to handle the package documentation. Also, there is a v1.7.0 tag for this release and we will continue to tag all pip releases.
In order to update the info on the pypi site, it seems I would need to push a new version. Would it be fine to wait for our next patch (1.7.1 most likely) for this info to be updated on the pypi site?
Cool, thanks a lot! This will be a big help.
As long as we know what's coming, I think waiting for the next patch should be fine, as long as it'll be within the next month or so. I'm surprised PyPI manages all metadata through the package, it's not even possible to update the "Homepage" link.