[Distutils] Simplify 426: Deprecate Author-email and Maintainer-email

[Donald Stufft]

On Apr 24, 2013, at 12:42 PM, Donald Stufft <donald at stufft.io> wrote:

> 
> On Apr 24, 2013, at 11:14 AM, Nick Coghlan <ncoghlan at gmail.com> wrote:
> 
>> On Thu, Apr 25, 2013 at 12:45 AM, Daniel Holth <dholth at gmail.com> wrote:
>>> Keep in mind that this is the structured index metadata, which is only
>>> used to grab requirements (for end users, who usually don't need the
>>> other information at all) and used to generate cheese shop web pages.
>>> AUTHORS.txt works when you don't need an automatic "email the author"
>>> button. Or the project's github information etc.
>>> 
>>> Someday the JSON version of the metadata will certainly make all these
>>> fields a little nicer to parse though.   Maybe
>>> 
>>> "authors" : [{'name':'bob', 'email':'bob at example.org'}]
>>> 
>>> The author/maintainer distinction will stay.
>> 
>> FWIW, the current draft of PEP 426 has this note:
>> 
>> .. note:
>> 
>>   This section currently mimics the flat layout used in past metadata
>>   versions. Perhaps it would be better to switch to a different format
>>   closer to that used for the project URL field::
>> 
>>       "contacts": {
>>               "author": "\"C. Schultz\" <cschultz at example.com>"
>>               "maintainer": "\"P. Patty\" <ppatty at example.com>"
>>           }
>> 
>> So yeah, I'm not particularly happy with the current structure for the
>> contact metadata either, but it's a *long* way down my priority list
>> of problems to address in the next draft. (My aim to get that posted
>> last week proved to be overly optimistic. Because this next update is
>> the key-value -> JSON-compatible structured metadata switch, it's hard
>> to post a partial update and still have it even vaguely readable)
>> 
>> Cheers,
>> Nick.
>> 
>> --
>> Nick Coghlan   |   ncoghlan at gmail.com   |   Brisbane, Australia
>> _______________________________________________
>> Distutils-SIG maillist  -  Distutils-SIG at python.org
>> http://mail.python.org/mailman/listinfo/distutils-sig
> 
> 
> Looking at other languages they all seem to accept N number of "authors" or
> "contributors". Possibly something like that would be a good to do.
> 
> -----------------
> Donald Stufft
> PGP: 0x6E3CBCE93372DCFA // 7C6B 7C5D 5E2B 6356 A926 F04F 6E3C BCE9 3372 DCFA
> 
> _______________________________________________
> Distutils-SIG maillist  -  Distutils-SIG at python.org
> http://mail.python.org/mailman/listinfo/distutils-sig



To be specific, here's what node.js does

They have an Author field, who represents the primary author of the package,
and then a contributors field that accepts a list of people who have contributed
to the package. NPM will also automatically fill this out if left blank by using an
AUTHORS file assuming the file has 1 per line and each line is in the format
of Name <email> (url).

Ruby has an authors field which is a list of all the authors.

-----------------
Donald Stufft
PGP: 0x6E3CBCE93372DCFA // 7C6B 7C5D 5E2B 6356 A926 F04F 6E3C BCE9 3372 DCFA

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 841 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <http://mail.python.org/pipermail/distutils-sig/attachments/20130424/5607945a/attachment.pgp>