|
| 1 | +Integration guide |
| 2 | +================= |
| 3 | + |
| 4 | +We provide multiple APIs to help you integrate with PyPI; see |
| 5 | +:doc:`index`. |
| 6 | + |
| 7 | + |
| 8 | +Migrating to the new PyPI |
| 9 | +------------------------- |
| 10 | + |
| 11 | +If your site/service used to link or upload to pypi.python.org, you |
| 12 | +should start using pypi.org instead. |
| 13 | + |
| 14 | +Here are some tips. |
| 15 | + |
| 16 | +.. note:: |
| 17 | + ``{name}`` is the name of the package as represented in the URL; |
| 18 | + for ``https://pypi.org/project/arrow/``, you'd insert ``arrow`` |
| 19 | + wherever you see ``{name}``. |
| 20 | + |
| 21 | +* If your client correctly follows redirects, you can replace |
| 22 | + ``pypi.python.org`` in your links with ``pypi.org`` and everything |
| 23 | + should just work. ``https://pypi.org/pypi/{name}`` (with or |
| 24 | + without a trailing slash) redirects to |
| 25 | + ``https://pypi.org/project/{name}/``. |
| 26 | + |
| 27 | +* In case you prefer a shorter URL: feel free to link to |
| 28 | + ``https://pypi.org/p/{name}/``, which will redirect to |
| 29 | + ``https://pypi.org/project/{name}/``. |
| 30 | + |
| 31 | +* JSON API: ``https://pypi.org/pypi/{name}/json`` returns the |
| 32 | + expected JSON response directly -- see :doc:`json`. |
| 33 | + |
| 34 | +* Package upload RSS feed: ``https://pypi.org/pypi?%3Aaction=rss`` |
| 35 | + redirects to ``https://pypi.org/rss/updates.xml``. See |
| 36 | + :doc:`feeds`. |
| 37 | + |
| 38 | +If you're a PyPI end user or packager looking to migrate to the new |
| 39 | +PyPI, please see `the official Python Packaging User Guide on |
| 40 | +migrating to PyPI |
| 41 | +<https://packaging.python.org/guides/migrating-to-pypi-org/>`_. |
0 commit comments