PEP 453: update the "Installing Python Modules" documentation

[ncoghlan]

BPO	19407
Nosy	@loewis, @birkenfeld, @ncoghlan, @larryhastings, @benjaminp, @merwok, @dstufft
Dependencies	bpo-19406: PEP 453: add the ensurepip module
Files	issue19407_packaging_docs.diff: WIP patch (new guides are placeholders)

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/ncoghlan'
closed_at = <Date 2014-03-13.12:14:04.955>
created_at = <Date 2013-10-26.12:44:35.758>
labels = ['deferred-blocker', 'type-feature', 'docs']
title = 'PEP 453: update the "Installing Python Modules" documentation'
updated_at = <Date 2015-11-02.07:34:28.425>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2015-11-02.07:34:28.425>
actor = 'Jon Snoo'
assignee = 'ncoghlan'
closed = True
closed_date = <Date 2014-03-13.12:14:04.955>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2013-10-26.12:44:35.758>
creator = 'ncoghlan'
dependencies = ['19406']
files = ['34307']
hgrepos = []
issue_num = 19407
keywords = ['patch']
message_count = 23.0
messages = ['201343', '201344', '201348', '201711', '201737', '202531', '205786', '205789', '205792', '207175', '207201', '212928', '212931', '212943', '212946', '212947', '213118', '213199', '213388', '213389', '213391', '213450', '253897']
nosy_count = 10.0
nosy_names = ['loewis', 'georg.brandl', 'ncoghlan', 'larry', 'benjamin.peterson', 'eric.araujo', 'python-dev', 'dstufft', 'Marcus.Smith', 'Jon Snoo']
pr_nums = []
priority = 'deferred blocker'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue19407'
versions = ['Python 3.4']

[ncoghlan]

Updating the "Installing Python Modules" docs in 2.7, 3.3 and default to recommend pip as the default cross-platform installer.

[ncoghlan]

Once bpo-19406 is implemented, this will need an additional update to indicate pip should be available by default in 3.4.

[ncoghlan]

bpo-19347 tracks overall PEP-453 implementation progress

[ncoghlan]

Marcus Smith (aka @qwcode) has made good strides this week in getting the Python Packaging User Guide to a presentable state using the current Python docs theme.

Bootstrapping: https://python-packaging-user-guide.readthedocs.org/en/latest/setup.html
Usage: https://python-packaging-user-guide.readthedocs.org/en/latest/installation.html

Accordingly, I think it makes sense to:

1. Arrange for a copy of this guide to be hosted somewhere on docs.python.org
2. Refer to that from the per-version distutils guides rather than referring directly to pip-installer.org

Thoughts?

[ncoghlan]

Alternative (more sensible) option - leave the packaging user guide hosted on ReadTheDocs, and if we decide to add a python.org subdomain for it later, that won't break any existing links.

[ncoghlan]

Larry, just a heads up that as a docs patch that isn't directly affected by the feature freeze, I likely won't get to this one until after beta 1.

We'll make sure bpo-19406 and the other functional changes are resolved, though.

[ncoghlan]

After reviewing the Extending & Embedding docs recently, I think a disclaimer/redirect to the tool recommendations in the Python Packaging User Guide is appropriate there as well.

Marcus also added an issue to update the distutils docs themselves: https://bitbucket.org/pypa/python-packaging-user-guide/issue/29/modernize-distutils-docs

(The user guide tracker is currently serving as a metatracker for docs issues for all the core tools)