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
Legacy JSON API Differences #233
Comments
About bugtrack_url: IIRC it was something added by the PyPI maintainers to help projects, but in parallel PEP 345 introduced Project-URL which was intended to cover source code repository, bug tracker, mailing list, etc. If PEP 426 or one of its companion keeps Project-URL (and maybe improves it with defined labels for common sites, e.g. "repository"), then this special case becomes redundant. You may want to keep it anyway to avoid breaking clients; I don’t know if they expect the key to be missing or the value to be null. |
Yea. In the UI the project urls and the few dedicated urls we have (homepage, bugtrack_url) are treated as just "special" project urls, but visually the same as the rest. This is primarily for backwards compat. |
If something is going to be removed, I'd do this as a next API version. |
PyPI also added the full releases list to the JSON dump to help mirrors. |
Interesting, regarding point 1, the warehouse code explicitly turns nulls into I don't recall why I implemented that in the Warehouse legacy code (except that XML-RPC didn't support explicit nulls for a very long time and I'm old). I'll remove it. The other changes are straight-forward and I'll address them. |
There's a parameter to xmlrpc to make it support None FWIW. Not sure if that's OK to do or not. |
to define the bug tracker, documentation website, and repository. Remove the obsolete parameter `bugtrack_url`. [1] https://www.python.org/dev/peps/pep-0345/#project-url-multiple-use [2] https://packaging.python.org/guides/distributing-packages-using-setuptools/#project-urls [3] https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#metadata [4] pypi/warehouse#233
Relevant references: - [PEP 345][1] - [packaging.python.org][2] - [`setuptools` documentation][3] This change defines the: - bug tracker - documentation website - API documentation website - source code repository. Remove the obsolete parameter [`bugtrack_url`][4]. [1]: https://www.python.org/dev/peps/pep-0345/#project-url-multiple-use [2]: https://packaging.python.org/guides/distributing-packages-using-setuptools/#project-urls [3]: https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#metadata [4]: pypi/warehouse#233
to define the bug tracker, documentation website, and repository. References: - [PEP 345][1] - ["`setup()` args"][2] in the Python Packaging User Guide - ["Metadata"][3] in the `setuptools` documentation - [`warehouse` issue 233][4] [1]: https://www.python.org/dev/peps/pep-0345/#project-url-multiple-use [2]: https://packaging.python.org/guides/distributing-packages-using-setuptools/#project-urls [3]: https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#metadata [4]: pypi/warehouse#233
to define the bug tracker, documentation website, and repository. References: - [PEP 345][1] - ["`setup()` args"][2] in the Python Packaging User Guide - ["Metadata"][3] in the `setuptools` documentation - [`warehouse` issue 233][4] [1]: https://www.python.org/dev/peps/pep-0345/#project-url-multiple-use [2]: https://packaging.python.org/guides/distributing-packages-using-setuptools/#project-urls [3]: https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#metadata [4]: pypi/warehouse#233
to define the: - bug tracker - documentation website, and - repository. References: - [PEP 345][1] - ["`setup()` args"][2] in the Python Packaging User Guide - ["Metadata"][3] in the documentation of `setuptools` - [`warehouse` issue 233][4] [1]: https://www.python.org/dev/peps/pep-0345/#project-url-multiple-use [2]: https://packaging.python.org/guides/distributing-packages-using-setuptools/#project-urls [3]: https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#metadata [4]: pypi/warehouse#233
to define the: - bug tracker - documentation website, and - repository. References: - [PEP 345][1] - ["`setup()` args"][2] in the Python Packaging User Guide - ["Metadata"][3] in the documentation of `setuptools` - [`warehouse` issue 233][4] [1]: https://www.python.org/dev/peps/pep-0345/#project-url-multiple-use [2]: https://packaging.python.org/guides/distributing-packages-using-setuptools/#project-urls [3]: https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html#metadata [4]: pypi/warehouse#233
""
instead ofnull
, determine if this matterscreated
in the Warehouse API which appears to be a timestamp, should probably be a str time representation or omitted.requires_python
,cheesecake_code_kwalitee_id
,cheesecake_documentation_id
,cheesecake_installability_id
,_pypi_hidden
,_pypi_ordering
,bugtrack_url
.Of the missing fields I think it's reasonable to remove
cheesecake_*
as cheesecake hasn't been a thing in some time. I also think it's reasonable to remove_pypi_hidden
as Warehouse removes the concept of Hidden releases._pypi_ordering
seems like a reasonable thing to remove as well as it shouldn't generally be useful.bugtrack_url
should be added to Warehouse andrequires_python
could go either way since it's not really used.The text was updated successfully, but these errors were encountered: