Twine: Twine check failing with "Warning: Inline literal start-string without end-string." output

[PyDataBlog]

Your Environment

Thank you for taking the time to report an issue.

To more efficiently resolve this issue, we'd like to know some basic information about your system and setup.

1) Your operating system:
Windows 10

2) Version of python you are running:

Python 3.6.7

3) How did you install twine? Did you use your operating system's package manager or pip or something else?

Twine installed via conda package manager

4) Version of twine you have installed (include complete output of):

twine version 1.13.0 (pkginfo: 1.5.0.1, requests: 2.22.0, setuptools: 41.0.1,
requests-toolbelt: 0.9.1, tqdm: 4.32.2)

5) Which package repository are you targeting?
Coinsta

The Issue

Twine is currently failing the markdown check (readme here) for what seems like legit markdown to me. It's currently failing on line 93: Warning: Inline literal start-string without end-string. where that line simply is a code block that starts as;

```python
# import the Historical class
from coinsta.core import Historical
from datetime import date

# specify dates considered
start = date(2018, 3, 1)
end = date(2018, 6,1)

# get data
coin_spec = Historical('btc', start=start, end=end)
btc_data = coin_spec.get_data()
print(btc_data.head())


#by default the end date is set to use the "today's" date
# of the user unless otherwise specified like above

Steps to Reproduce

If the issue is predictable and consistently reproducible, please list the steps here.

python setup.py sdist bdist_wheel
twine check dist/*

Output:

running sdist
running egg_info
writing coinsta.egg-info\PKG-INFO
writing dependency_links to coinsta.egg-info\dependency_links.txt
writing requirements to coinsta.egg-info\requires.txt
writing top-level names to coinsta.egg-info\top_level.txt
reading manifest file 'coinsta.egg-info\SOURCES.txt'
writing manifest file 'coinsta.egg-info\SOURCES.txt'
running check
creating coinsta-0.1.4
creating coinsta-0.1.4\coinsta
creating coinsta-0.1.4\coinsta.egg-info
copying files to coinsta-0.1.4...
copying README.md -> coinsta-0.1.4
copying setup.cfg -> coinsta-0.1.4
copying setup.py -> coinsta-0.1.4
copying coinsta\__init__.py -> coinsta-0.1.4\coinsta
copying coinsta\core.py -> coinsta-0.1.4\coinsta
copying coinsta\exceptions.py -> coinsta-0.1.4\coinsta
copying coinsta\utils.py -> coinsta-0.1.4\coinsta
copying coinsta.egg-info\PKG-INFO -> coinsta-0.1.4\coinsta.egg-info
copying coinsta.egg-info\SOURCES.txt -> coinsta-0.1.4\coinsta.egg-info
copying coinsta.egg-info\dependency_links.txt -> coinsta-0.1.4\coinsta.egg-info
copying coinsta.egg-info\requires.txt -> coinsta-0.1.4\coinsta.egg-info
copying coinsta.egg-info\top_level.txt -> coinsta-0.1.4\coinsta.egg-info
copying coinsta.egg-info\zip-safe -> coinsta-0.1.4\coinsta.egg-info
Writing coinsta-0.1.4\setup.cfg
Creating tar archive
removing 'coinsta-0.1.4' (and everything under it)
running bdist_wheel
running build
running build_py
installing to build\bdist.win-amd64\wheel
running install
running install_lib
creating build\bdist.win-amd64\wheel
creating build\bdist.win-amd64\wheel\coinsta
copying build\lib\coinsta\core.py -> build\bdist.win-amd64\wheel\.\coinsta
copying build\lib\coinsta\exceptions.py -> build\bdist.win-amd64\wheel\.\coinsta
copying build\lib\coinsta\utils.py -> build\bdist.win-amd64\wheel\.\coinsta
copying build\lib\coinsta\__init__.py -> build\bdist.win-amd64\wheel\.\coinsta
running install_egg_info
Copying coinsta.egg-info to build\bdist.win-amd64\wheel\.\coinsta-0.1.4-py3.6.egg-info
running install_scripts
adding license file "LICENSE" (matched pattern "LICEN[CS]E*")
creating build\bdist.win-amd64\wheel\coinsta-0.1.4.dist-info\WHEEL
creating 'dist\coinsta-0.1.4-py3-none-any.whl' and adding 'build\bdist.win-amd64\wheel' to it
adding 'coinsta/__init__.py'
adding 'coinsta/core.py'
adding 'coinsta/exceptions.py'
adding 'coinsta/utils.py'
adding 'coinsta-0.1.4.dist-info/LICENSE'
adding 'coinsta-0.1.4.dist-info/METADATA'
adding 'coinsta-0.1.4.dist-info/WHEEL'
adding 'coinsta-0.1.4.dist-info/top_level.txt'
adding 'coinsta-0.1.4.dist-info/zip-safe'
adding 'coinsta-0.1.4.dist-info/RECORD'
removing build\bdist.win-amd64\wheel

Checking distribution dist\coinsta-0.1.4-py3-none-any.whl: Failed
The project's long_description has invalid markup which will not be rendered on PyPI. The following syntax errors were detected:
line 92: Warning: Inline literal start-string without end-string.
Checking distribution dist\coinsta-0.1.4.tar.gz: Failed
The project's long_description has invalid markup which will not be rendered on PyPI. The following syntax errors were detected:
line 92: Warning: Inline literal start-string without end-string.
line 92: Warning: Inline literal start-string without end-string

What am I doing wrong here?

[jamadden]

In setup.cfg there is:

long_description_content_type="text/markdown"

which leads to the wheel METADATA having

 Description-Content-Type: "text/markdown"

I don't think the quotes are correct. Indeed, if I remove them from setup.cfg (long_description_content_type = text/markdown) the error goes away.

[PyDataBlog]

In setup.cfg there is:

long_description_content_type="text/markdown"

which leads to the wheel METADATA having

 Description-Content-Type: "text/markdown"

I don't think the quotes are correct. Indeed, if I remove them from setup.cfg (long_description_content_type = text/markdown) the error goes away.

@jamadden Thank you so much Jason! You have caught a nasty bug in the setup config which has been around since the project began. I owe you one!

The test passes so feel free to close the issue.

[Borda]

@PyDataBlog we are having a very similar problem https://github.com/williamFalcon/pytorch-lightning/issues/468#issuecomment-550561408 I have already made corrections to have the very same setup as Coinsta but it does not help...
Moreover, I tried to upgrade to twine==2.0 and got https://github.com/williamFalcon/pytorch-lightning/issues/468#issuecomment-550983915

[PyDataBlog]

@PyDataBlog we are having a very similar problem williamFalcon/pytorch-lightning#468 (comment) I have already made corrections to have the very same setup as Coinsta but it does not help...
Moreover, I tried to upgrade to twine==2.0 and got williamFalcon/pytorch-lightning#468 (comment)

I suggest you post the setup config file here as that is usually the issue (at least for me). Additionally, I used some online markdown linter to inspect any issues with the readme md file, fix them and finally get the config sorted after @jamadden found the error.

[Borda]

Thank you, what MD linter do you recommend, I have tried https://dillinger.io/ but I do not see any option to check syntax...

[PyDataBlog]

Thank you, what MD linter do you recommend, I have tried https://dillinger.io/ but I do not see any option to check syntax...

Texlint could help

[PyDataBlog]

@Borda remarkjs also does the job

[kaushikb11]

@Borda What's the solution here? 😂

[Borda]

@Borda What's the solution here? 😂

heh you should ask me a year ago :D