warning: `long_description_content_type` missing. defaulting to `text/x-rst`.

Borda commented 4 years ago

System info/details

1) Your operating system: Linux Mint 19 2) Version of python you are running: 3.6 & 3.7 3) How did you install twine: pip install twine==1.13.0 4) Version of twine you have installed (include complete output of): 1.13.0 5) Which package repository are you targeting? PyTorch-Lighning

I found it very similar to https://github.com/pypa/twine/issues/479 ; we have an open issue about it https://github.com/williamFalcon/pytorch-lightning/issues/468 and the Travis build can be found here - https://travis-ci.org/Borda/pytorch-lightning/builds/608675304 in particular see: https://travis-ci.org/Borda/pytorch-lightning/jobs/608675305#L616

If you're having issues uploading a specific package, you must include a copy of the following:

The package's PKG-INFO file PKG-INFO.zip

The Issue

Checking distribution dist/pytorch-lightning-0.5.3.tar.gz: warning: `long_description_content_type` missing.  defaulting to `text/x-rst`.
Failed
The project's long_description has invalid markup which will not be rendered on PyPI. The following syntax errors were detected:
line 77: Warning: Inline literal start-string without end-string.

Steps to Reproduce

see forked branch - https://github.com/Borda/pytorch-lightning/tree/issue_468

python setup.py sdist
twine check dist/*

jamadden commented 4 years ago

I believe I see the problem in the PKG-INFO:

Metadata-Version: 2.1
Name: pytorch-lightning
Version: 0.5.3
Summary: # PyTorch Lightning

The lightweight PyTorch wrapper for ML researchers. Scale your models. Write less boilerplate.

Home-page: https://github.com/williamFalcon/pytorch-lightning
Author:  William Falcon et al.
Author-email: waf2107@columbia.edu
License: Apache-2.0
Download-URL: https://github.com/williamFalcon/pytorch-lightning
Description: <div align="center">

        ![Logo](./docs/source/_static/lightning_logo_small.png)

        # PyTorch Lightning

The Summary field, which comes from the description= keyword argument in setup.py is specifically defined to be a one-line value. Introducing newlines breaks the file format and causes everything after it to be treated as the long-description; the remainder of the specified metadata is ignored. (The file format is essentially email; the first blank line signals the end of "headers" and the beginning of the "body", and the "body" can be the long-description. A number of different fields can cause this problem, commonly Summary/description= and License/license=)

Borda commented 4 years ago

Wow, that would not cross my mind, I was debugging around and around README... @jamadden it seems to help locally, let me try to test in CI and then I will close this.

pypa / twine