PyPI release needed

[icemac]

After Python 3 support was added to this package a new release to PyPI is needed.

Could someone please cut a release or give me (icemac) the needed rights on PyPI?

[garyposter]

I gave you privileges. Thank you!

[icemac]

I just released https://pypi.org/project/zc.relation/1.1/. But something went wrong with the long_description it seems to contain the whole PKG-INFO. I'll fix this in #6.

[mgedmin]

That is a very peculiar long_description. How did you do the upload?

[icemac]

@mgedmin I used zest.releaser. I never had problems like this with this tool.

[jamadden]

I think this is an unfortunate interaction stemming from when .txt files were renamed to .rst.

It all goes back to this line from setup.py:

setup(
   ...
   description=text("README.rst"),
   ...
)

The text helper function inserts newlines at the end of .rst files:

# simplified
def text(*args, **kwargs):
    # note: distutils explicitly disallows unicode for setup values :-/
    # http://docs.python.org/dist/meta-data.html
    tmp = []
    for a in args:
        if a.endswith('.rst'):
            f = open(os.path.join(*a.split('/')))
            tmp.append(f.read())
            f.close()
            tmp.append('\n\n')
        else:
             ...
    if len(tmp) == 1: # NEVER TRUE for .rst files, see above!
        res = tmp[0]
    else:
        res = ''.join(tmp)
    return res

So the description ends up being 'Index intransitive and transitive n-ary relationships.\n\n\n'

Which translates to PKG_INFO as

Metadata-Version: 2.1
Name: zc.relation
Version: 1.1
Summary: Index intransitive and transitive n-ary relationships.



Home-page: https://github.com/zopefoundation/zc.relation
Author: Gary Poster
Author-email: [email protected]
License: ZPL 2.1
Description: ================
        Relation Catalog
        ================

I know that wheel used the email libraries for dealing with metadata, leading to breakage, and I suspect PKG_INFO parsers did or do likewise, so the extra newlines after Summary would be interpreted as the end of the headers and beginning of the body. (EDIT: That's specified by metadata 2.1) The body is what gets rendered if there's no Description key, and the body isn't valid reST (unexpected indentation on line 6, Relation Catalog), so...mangled page on PyPI.

[icemac]

@jamadden Thank you for your deep analysis. I fixed the PyPI page although I needed two releases to achieve this. I should have read your analysis more care fully. Sorry.

[mgedmin]

Oh wow! This is also a setuptools bug IMHO: it should reject newlines in the description field.

[mgedmin]

Filed pypa/setuptools#1390