Create json.rst

[cclauss]

Document this important method for accessing PyPI package info. Fixes #2913.

[cclauss]

I am not clear on what is expected when I see the message codecov/project — Waiting for status to be reported below. I have not used https://pypi.python.org/pypi/coverage before but I am interested to learn how it applies to the addition of a .rst file.

[codecov]

Codecov Report

Merging #1721 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #1721   +/-   ##
======================================
  Coverage     100%    100%           
======================================
  Files          82      82           
  Lines        2957    2957           
  Branches      356     356           
======================================
  Hits         2957    2957

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d19be03...6cf75e4. Read the comment docs.

[di]

Hi @cclauss, thanks for your contribution. Could you update this to refer to pypi.org instead of pypi.python.org? For example, with generic URLs like:

• https://pypi.org/pypi/<project_name>/json for projects
• https://pypi.org/pypi/<project_name>/<version>/json for individual releases

Some discussion about what the different endpoints could be used for would be great as well. For example, the projects endpoint lists all releases for a project, and the release endpoint includes all the files as well as MD5 and SHA256 hashes.

(Since this PR is a bit old, if you're not interested in it anymore, just let me know and I'll close it.)

[brainwane]

Hi @cclauss -- just wanted to let you know we discussed this PR in our meeting today and would love for you to update and extend it to add more instructions for developers using the API!

[cclauss]

Cool.. Will work on it.

[brainwane]

@cclauss I want to give you a heads-up: @di has a PR open, #2992, that addresses a bunch of the same points as your PR. But after his PR is merged, I would still welcome more API documentation from you, such as the example usage you were working on in this PR, or resolving some of our open documentation issues.