[Distutils] Another conversation starter - pip documentation in the Python docs

[Paul Moore]

On 14 July 2013 18:02, Marcus Smith <qwcode at gmail.com> wrote:

> there's a section marked "Installation Tutorial".  Someone wanting to
> install packages should be able to get into that, once it actually has
> content  : )
>

Yes, I see that. I'm not sure I like the up-front "decide between user or
system or virtualenv" presentation, though. I'm working on something I
prefer, see what you think when it's done.

My perspective is that someone who's used to writing Python code wants to
install requests (and get on with his latest script). How does he do that?
He doesn't want to be presented with decisions to make, he just wants to
know how to do it. "pip install --user requests" is the answer he is
looking for, frankly. (Missing out --user gets permission issues to deal
with, and virtualenvs are more than he's looking to deal with at the
moment).

The guide should get this person to that command as quickly as possible.

I think we should explain *in the core documentation*
>>
> How about if I provide a new (short) document called something like
>> "Python package management"
>>
>
> IMO, we should put the energy into one comprehensive document (the new
> user guide) and link out to it, not duplicate effort into the core docs.
>

OK... But remember that most users are consumers of packages, not creators
of them. The packaging guide should reflect that with "install and maintain
packages" on page 1, and creating packages squarely in "advanced" usage. Is
that in line with the goals of the packaging guide? (If not, let's just get
a user-only starter page in the Python docs and leave the packaging guide
as the "more comprehensive" documentation it can refer to).

Paul
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20130714/d9624f2d/attachment.html>