Fix pypi deployment by using documentation at markdown format

[4383]

podman README.md is markdown file who is used as a long description
so we need to specify to pypi to use markdown parser to properly
upload package

https://pypi.org/help/#description-content-type

[4383]

Are you sure you fix the issue with #35 ?

The CI still fail on 0.0.2 and on a documentation format error

The pypi documentation tell us to use long_description_content_type="text/markdown"

• https://pypi.org/help/#description-content-type
• https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py

[4383]

Feel free to close this PR if it's already good for you

[rhatdan]

LGTM
@jwhonce PTAL

[4383]

FYI, take care, it's a sort of rollback of the code before #35, but normally it's the right way to use README markdown format

[4383]

we can test it by pushing a 0.0.3 and in a second time we need to update the README to explain how to install from pypi, I will submit a patch related to this, don't merge it until the deployment fail is not fixed.

[4383]

openstack have the same issue:

http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007459.html, I don't think that this is a podman issue...

Anyway these changes can be merged since they fix some nits and bad config names.

[4383]

Well... I think the issue here is related to:

• Fail uploads with an invalid description pypi/warehouse#5835
• HTTPError: 400 Client Error: The description failed to render in the default format of reStructuredText pypi/warehouse#5890

[4383]

According to this comment my local tests on python-podman seems ok:

$ twine check dist/*                                                                                                                      
Checking distribution dist/podman-0.0.3.dev1-py2.py3-none-any.whl: Passed
Checking distribution dist/podman-0.0.3.dev1.tar.gz: Passed

[4383]

I don't know why but on travis the same tests fails

[4383]

Locally I use:

$ pip list
Package           Version  
----------------- --------- 
pbr               5.3.1    
setuptools        41.0.1   
twine             1.13.0   
wheel             0.33.4   

and on travis:

• setuptools 41.0.1
• twine 1.13.0
• wheel 0.33.4

The used packages are the sames and the check result is different...

[4383]

#32 we already publish sdist and bdist_wheel but the deployment is stuck by a pypi recent updates who reintroduce some deactivated tests on the long_description format...

[di]

I think these keywords are producing an invalid PKG-INFO file, they look like this on Travis:

Keywords: varlink
libpod
podman

But should look like:

Keywords: varlink,libpod,podman

However I'm not sure where the bug lies.

[4383]

I think these keywords are producing an invalid PKG-INFO file, they look like this on Travis:

Keywords: varlink
libpod
podman

But should look like:

Keywords: varlink,libpod,podman

However I'm not sure where the bug lies.

@di Oh thanks, good catch!

I have already fixed this error on pbr but I need to verify why it still occur here.

I'll test with the inline syntaxe keywords: varlink, libpod, podman but I don't think it's an issue who can explain why twine check dist/* fail on travis.

[4383]

Well it look like the issue is now fixed since I use the same commands that use pypa on their side to check that it work.

I think we can be confident with my proposed changes, and I think we can move forward by merging these changes and testing to deploy a release 0.0.3.

I want to keep the tests part (twine check dist/*) to ensure us that if we change things on README.md then we will detect potential markdown errors via the CI.

@di a greate thanks for all your help :)

In a second time I will inspect why pbr doesn't manage keywords in weird way even with my previous fix.

[4383]

@jwhonce @rhatdan PTAL

[rhatdan]

LGTM