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

Legacy JSON API Differences #233

Closed
5 tasks
dstufft opened this issue Mar 7, 2014 · 6 comments · Fixed by #446
Closed
5 tasks

Legacy JSON API Differences #233

dstufft opened this issue Mar 7, 2014 · 6 comments · Fixed by #446
Assignees

Comments

@dstufft
Copy link
Member

dstufft commented Mar 7, 2014

  • A number of fields report "" instead of null, determine if this matters
  • File URLs are relative instead of absolute in Warehouse
  • There is a new field created in the Warehouse API which appears to be a timestamp, should probably be a str time representation or omitted.
  • The following fields are missing: requires_python, cheesecake_code_kwalitee_id, cheesecake_documentation_id, cheesecake_installability_id, _pypi_hidden, _pypi_ordering, bugtrack_url.
  • Add releases list https://bitbucket.org/pypa/pypi/pull-request/28

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 and requires_python could go either way since it's not really used.

@dstufft dstufft added this to the Become PyPI milestone Mar 7, 2014
@merwok
Copy link
Contributor

merwok commented Mar 7, 2014

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.

@dstufft
Copy link
Member Author

dstufft commented Mar 7, 2014

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.

@techtonik
Copy link

If something is going to be removed, I'd do this as a next API version.

@r1chardj0n3s
Copy link

PyPI also added the full releases list to the JSON dump to help mirrors.

@r1chardj0n3s
Copy link

Interesting, regarding point 1, the warehouse code explicitly turns nulls into "" "to make XML-RPC happy." Actual legacy (PyPI) doesn't do that.

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.

@r1chardj0n3s r1chardj0n3s self-assigned this Apr 16, 2014
@dstufft
Copy link
Member Author

dstufft commented Apr 16, 2014

There's a parameter to xmlrpc to make it support None FWIW. Not sure if that's OK to do or not.

johnyf added a commit to tulip-control/tulip-control that referenced this issue Jun 2, 2021
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
johnyf added a commit to tulip-control/dd that referenced this issue Jun 20, 2021
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
johnyf added a commit to tulip-control/dd that referenced this issue Jun 21, 2021
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
johnyf added a commit to tulip-control/dd that referenced this issue Jan 11, 2022
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
johnyf added a commit to tulip-control/dd that referenced this issue Jan 11, 2022
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
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 a pull request may close this issue.

4 participants