[Distutils] PEP 345 - 3 new fields

[Ian Bicking]

On Tue, Dec 1, 2009 at 9:11 AM, Tarek Ziadé <ziade.tarek at gmail.com> wrote:

> On Tue, Dec 1, 2009 at 4:19 AM, Ian Bicking <ianb at colorstudy.com> wrote:
> [..]
> > If something more like that was added (more like Trunk-URL), that would
> be
> > genuinely useful.  Barring that, I'd recommend removing the
> Repository-URL
> > field from the recommendation until we have a clearer use case.  Right
> now,
> > the better use case would be a field giving the checkout command, e.g.,:
> >   Repository-Checkout: hg clone http://bitbucket.org/ianb/webob
> > But I don't think that is particularly useful, only that it is more
> useful
> > than Repository-URL.
>
> Here's a proposal then, that seems to synthetize what people have been
> saying:
>
> Let's drop "Repository-Browse-URL" and keep a single "Repository-URL"
> field, which is a free
> URL that can take any URL form. e.g. a browsable url, or a git/hg url etc.
>

I prefer Repository-Browse-URL, as it is more explicit in its use: it's a
link that someone using a browser can usefully click through to.  I expect
it will be displayed as such on PyPI.  So this link is good:

  http://github.com/cloudkick/libcloud

And this link is bad:

  git://github.com/cloudkick/libcloud.git

A similar distinction exists for code.google.com projects.

Now for "Change-Log" vs "Change-Log-URL", I think the first one is
> better, because
> that's what people are already doing in their packages (when they add
> their changelog at the
> end of their long_description option), and it's not hard for PyPI to
> store it and display it, besides
> Description.
>

This seems fine to me.  Is ReST allowed?  Could one potentially just do:

  `Changes <http://myproject.com/changes.html>`_

?  And then essentially the changelog would be a single link?  I'm not sure
if that's a good idea.  Would it be too vague to say that if the change log
is a single URL that PyPI should link directly through to the change log
instead of displaying the link?  (The exact UI for PyPI hasn't been
proposed, but if it's something like a tab with changes, that tab could
actually link offsite)

-- 
Ian Bicking  |  http://blog.ianbicking.org  |
http://topplabs.org/civichacker
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20091201/79c0cd78/attachment-0001.htm>