Differences between revisions 14 and 29 (spanning 15 versions)
Revision 14 as of 2018-03-22 01:04:28
Size: 8613
Comment: testing suggestions
Revision 29 as of 2018-03-26 16:13:31
Size: 115
Comment: formatting
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
DRAFT

= PyPI beta announcement =
['''This page is a draft''' and ''not to be used/publicized'' until we close out [[https://github.com/pypa/warehouse/milestone/10|the "publicize beta" milestone]]. That'll probably be by March 25, 2018.]

The new Python Package Index is now in beta at https://pypi.org/. We predict the full switch will happen in April 2018 ([[https://wiki.python.org/psf/WarehouseRoadmap|roadmap]]), so here's a heads-up about why we're switching, what's changed, and what to expect. To get an email when the new site replaces the old one, please sign up for [[https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/|the low-traffic PyPI announcements email list]].

<<TableOfContents()>>

== Context ==
[[https://pypi.python.org|The legacy PyPI site https://pypi.python.org]] started in the early 2000s. Users face outages, malicious packages, and spam attacks, and the legacy codebase has made it hard to maintain and even harder to develop new features.

[[http://pypi.org/|The new PyPI http://pypi.org/]] (codebase: [[http://warehouse.readthedocs.io/|Warehouse]]) looks more modern, and is up-to-date under the hood too; a proper web framework (Pyramid), 100% backend test coverage, and a Docker-based development environment make it easier for current and new developers to maintain it and add features.

Thanks to [[https://pyfound.blogspot.com/2017/11/the-psf-awarded-moss-grant-pypi.html|Mozilla's Open Source Support funding]], we have designed and added new features, overhauled infrastructure, and worked towards redirecting traffic to the new site and shutting down the old one. The full switch will include redirecting browser and `pip install` traffic from the old site; then, sometime in late April or early May, the legacy site will be entirely shut down.

== Migrating ==
'''You may not need to change anything right away.''' Thanks to redirects, your sites, services, and tools will probably be able to seamlessly switch to the new site.

'''Users''': No change necessary. `pip install` works as normal.

'''Package maintainers''': Use [[https://pypi.org/project/twine/|Twine]] to [[https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi|upload releases]], and update the URL you upload to. New PyPI takes the same username/password as legacy PyPI did. Follow [[https://packaging.python.org/guides/migrating-to-pypi-org/|the packagers' migration guide]].

'''API users''': follow [[https://warehouse.readthedocs.io/api-reference/integration-guide/#migrating-to-the-new-pypi|the API users' migration guide]].

If you're affected by a deprecation (below), you should adapt and migrate by early April 2018. Sign up for [[https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/|the low-traffic PyPI announcements email list]] to get a heads-up when we have a more precise date.

=== New PyPI Features ===
 * mobile-responsive UI
 * chronological release history for each project ([[https://pypi.org/project/pip/#history|example]])
 * easy-to-read project activity journal for project maintainers
 * better search and filtering
 * support for multiple project URLs (e.g., [[https://packaging.python.org/tutorials/distributing-packages/#project-urls|for a homepage and a repo]])
 * [[https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi|support for Markdown READMEs for source distributions]] ([[https://github.com/pypa/warehouse/issues/869#issuecomment-374425355|soon]]: wheels too)
 * user-visible Gravatars and email addresses for maintainers
 * no need to "register" a project before initial upload
 * far better backend infrastructure, reducing the frequency of outages

=== Deprecations ===
Things that already have gone away (sometimes for policy or spam-fighting reasons) include:

 * uploading via pypi.python.org: [[https://mail.python.org/pipermail/distutils-sig/2017-July/030849.html|uploads must go through the new site's API]]
 * creating a user account on pypi.python.org: [[https://status.python.org/incidents/mgjw1g5yjy5j|new user account registration now only on pypi.org]]
 * uploading to pythonhosted.com documentation hosting ([[https://github.com/pypa/warehouse/issues/582|discussion and plans]])
 * [[https://warehouse.readthedocs.io/api-reference/xml-rpc/#changes-to-legacy-api|download counts visible in the API]]: instead, use [[https://packaging.python.org/guides/analyzing-pypi-package-downloads/|the Google BigQuery service]])
 * key management: PyPI no longer has a UI for users to manage GPG or SSH public keys
 * uploading new releases via the web UI: instead, we recommend the command-line tool [[http://twine.readthedocs.io/|Twine]]
 * updating release descriptions via the web UI: instead, to update release metadata, you need to upload a new release ([[https://mail.python.org/pipermail/distutils-sig/2017-December/031826.html|discussion]])
 * [[https://status.python.org/incidents/mgjw1g5yjy5j|uploading a package without first verifying an email address]]
 * [[https://mail.python.org/pipermail/distutils-sig/2017-October/031712.html|HTTP access to APIs; now it's HTTPS-only]]

Things that will go away once legacy PyPI shuts down:

 * GPG/PGP signatures for packages (still visible in the [[https://warehouse.readthedocs.io/api-reference/legacy/#simple-project-api|Simple Project API]] per [[https://www.python.org/dev/peps/pep-0503/|PEP 503]], but no longer visible in the web UI)
 * [[https://mail.python.org/pipermail/distutils-sig/2018-January/031855.html|OpenID and Google auth login]]

Late 2018 or later:

 * deprecating the XML-RPC API and [[https://github.com/pypa/warehouse/issues?q=is:open+is:issue+label:APIs/feeds|rearchitecting our APIs]]

== Future plans ==
See [[https://github.com/pypa/warehouse/issues|our issue tracker]]. Includes:

 * more timely package name takeovers ([[https://www.python.org/dev/peps/pep-0541/|PEP 541]])
 * [[https://github.com/pypa/warehouse/issues/996|two-factor authentication]]
 * a [[https://github.com/pypa/warehouse/issues/3231|user support ticket system]]
 * [[https://github.com/pypa/warehouse/issues/1190|change your own username]]

For updates, please sign up for [[https://mail.python.org/mm3/mailman3/lists/pypi-announce.python.org/|the low-traffic PyPI announcements email list]].

== Security ==
If you find any potential security vulnerabilities, please [[https://pypi.org/security/|follow our published security policy]]. Please don't report security issues in Warehouse via !GitHub, IRC, or mailing lists. Instead, please directly email the security team.

== Please test! ==
The point of the beta is to find and fix bugs. Please help us. Most of these workflows you can test [[http://pypi.org/|on pypi.org]], using the same login as you use on [[http://pypi.python.org|pypi.python.org]] (legacy PyPI). For testing destructive actions, like removing an owner, deleting a project, or deleting a release, please use [[https://test.pypi.org/|test.pypi.org]].

=== Workflows ===

'''Package users''':

 * Register/confirm a new user
 * Login/logout
 * Reset password
 * Search for projects
 * [[https://packaging.python.org/tutorials/installing-packages/#installing-from-other-indexes|`pip install` a package]]
 * Download release files via browser
 * Call JSON, RSS, Simple, and XML-RPC APIs

'''Project maintainers''':
 * Add/remove a maintainer
 * Add/remove an owner
 * Transition ownership
 * Remove a project
 * Remove a release
 * View journals for a project
 * View journals for a release
 * [[https://packaging.python.org/tutorials/distributing-packages/|Upload a new release]] (source distribution and wheel; [[https://packaging.python.org/guides/migrating-to-pypi-org/|upgrade your versions of twine and setuptools]] first)
 * Confirm display of project description, release history, download files, project links, maintainers, tags, and classifiers ([[https://test.pypi.org/project/1234_hello_world/|example]])


== Contact us ==
Security issues: [[https://pypi.org/security/|email security @ python dot org]]

!GitHub for all other bug reports & feature requests:https://github.com/pypa/warehouse/issues/new

IRC: [[https://webchat.freenode.net/?channels=#pypa-dev|#pypa-dev on Freenode]] (someone's usually there 10am-5pm Central Time on weekdays)

Email: [[https://groups.google.com/forum/#!forum/pypa-dev|pypa-dev mailing list]]

(By participating, you agree to abide by the [[https://www.pypa.io/en/latest/code-of-conduct/|PyPA Code of Conduct]].)

Thank you for using PyPI!
Please see [[https://pyfound.blogspot.com/2018/03/warehouse-all-new-pypi-is-now-in-beta.html|the PSF blog post]].

Please see the PSF blog post.

PackagingWG/PyPIBetaAnnouncement (last edited 2018-03-26 16:13:31 by SumanaHarihareswara)

Unable to view page? See the FrontPage for instructions.