NREL / bifacialvf

Bifacial PV View Factor model for system performance calculation
https://bifacialvf.readthedocs.io
Other
29 stars 18 forks source link

PyPi deployment not working #21

Closed cdeline closed 5 years ago

cdeline commented 5 years ago

I'm trying to deploy 0.1.17 to PyPi but I'm getting the following errors with twine check. Any suggestions @mikofski ?

>>>python setup.py sdist
>>>twine check dist/*
Checking distribution dist\bifacialvf-0.1.7.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 81: Warning: Inline literal start-string without end-string.
mikofski commented 5 years ago

I think, but not sure, it might have something to do with the markdown in the readme. By default, PyPI expects ReStructured Text or .rst files, but if you are using the most current Twine, then you should be able to change the long description content type. See including your readme in your package's metadata.

mikofski commented 5 years ago

So it will work for wheels now, but not for the src-dist tarball.

$ twine check dist/*
Checking distribution dist/bifacialvf-0.1.7-py3-none-any.whl: Passed
Checking distribution dist/bifacialvf-0.1.7.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 83: Warning: Inline literal start-string without end-string.

There's a bug in Twine that keeps it from reading the correct content type, also evidently twine also requires readme_renderer[md] to parse the long description. And even then, it still says there's an error on line 83. Looking into this now, sometimes sneaky bad bytes sneak into text during copy and paste :(

mikofski commented 5 years ago

@cdeline

and you should be good to go