Skip to content

migration guide for third-party services #3153

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

Merged
merged 2 commits into from
Mar 8, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api-reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ parts of Warehouse that generate them.
json
legacy
xml-rpc
integration-guide
41 changes: 41 additions & 0 deletions docs/api-reference/integration-guide.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Integration guide
=================

We provide multiple APIs to help you integrate with PyPI; see
:doc:`index`.


Migrating to the new PyPI
-------------------------

If your site/service used to link or upload to pypi.python.org, you
should start using pypi.org instead.

Here are some tips.

.. note::
``{name}`` is the name of the package as represented in the URL;
for ``https://pypi.org/project/arrow/``, you'd insert ``arrow``
wherever you see ``{name}``.

* If your client correctly follows redirects, you can replace
``pypi.python.org`` in your links with ``pypi.org`` and everything
should just work. ``https://pypi.org/pypi/{name}`` (with or
without a trailing slash) redirects to
``https://pypi.org/project/{name}/``.

* In case you prefer a shorter URL: feel free to link to
``https://pypi.org/p/{name}/``, which will redirect to
``https://pypi.org/project/{name}/``.

* JSON API: ``https://pypi.org/pypi/{name}/json`` returns the
expected JSON response directly -- see :doc:`json`.

* Package upload RSS feed: ``https://pypi.org/pypi?%3Aaction=rss``
redirects to ``https://pypi.org/rss/updates.xml``. See
:doc:`feeds`.

If you're a PyPI end user or packager looking to migrate to the new
PyPI, please see `the official Python Packaging User Guide on
migrating to PyPI
<https://packaging.python.org/guides/migrating-to-pypi-org/>`_.
4 changes: 2 additions & 2 deletions warehouse/__about__.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
__commit__ = None

__author__ = "The Python Packaging Authority"
__email__ = "[email protected]"
__email__ = "[email protected]"

__license__ = "Apache License, Version 2.0"
__copyright__ = "2015 %s" % __author__
__copyright__ = "2018 %s" % __author__