Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Can not render markdown description properly #1

Closed
drunkwcodes opened this issue Mar 20, 2018 · 8 comments
Closed

Can not render markdown description properly #1

drunkwcodes opened this issue Mar 20, 2018 · 8 comments

Comments

@drunkwcodes
Copy link

I followed the guide and upgraded setuptools and twine, but it didn't render markdown properly after uploading.

And python setup.py check says

python\lib\distutils\dist.py:261: UserWarning: Unknown distribution option: '
long_description_content_type'

Here is my project: https://pypi.org/project/qquiz/

I used twine version 1.11.0 (pkginfo: 1.4.2, requests: 2.18.4, setuptools: 39.0.1, requests-toolbelt: 0.8.0, tqdm: 4.19.8) on Windows.

@di
Copy link
Owner

di commented Mar 20, 2018

@drunkwcodes Thanks for the report! Sorry this isn't working for you.

Looks like you're building wheels as well as source distributions, and therefore hitting pypa/wheel#231 (which has an open PR, pypa/wheel#232)

In short: wheel is not writing out the correct Metadata-Version, twine prefers sending wheels to PyPI before source distributions, and PyPI only pulls metadata from the first distribution sent for a new release.

You can wait until that fix to wheel is accepted and merged, or you could fix this by sending the distributions one at a time, with the source distribution first, in your next release. E.g.:

$ python setup.py sdist bdist_wheel
$ twine upload dist/qquiz-0.1.0b4.tar.gz 
$ twine upload qquiz-0.1.0b4-py3-none-any.whl 

@drunkwcodes
Copy link
Author

drunkwcodes commented Mar 20, 2018

Thanks for your quick reply, the workaround works well. I should read the whole page before trying!

👌 👌

@defjaf
Copy link

defjaf commented Mar 20, 2018

Thanks! For what it's worth, I note that the markdown rendering isn't perfect: see, e.g., this code block.

Is there a better place to report this (assuming this isn't a problem on my side)?

@di
Copy link
Owner

di commented Mar 20, 2018

@defjaf Please raise an issue over at https://github.com/pypa/warehouse/issues, it's been mentioned before but I don't think there's an issue for it, and it seems like it is a trivial styling change we can make (definitely not a problem on your side).

We're also working on adding Github Flavored Markdown (GFM) support at the moment, which might help with a lot of the other CommonMark shortcomings, see pypa/packaging-problems#126.

@defjaf
Copy link

defjaf commented Mar 21, 2018

Added this to the ongoing discussion of PIP566 compliance.

@di
Copy link
Owner

di commented Mar 21, 2018

It's not really related to PEP 566 compliance since it's just styling. I created pypi/warehouse#3330.

@defjaf
Copy link

defjaf commented Mar 21, 2018

@di that makes sense: sorry for the extra work!

costrouc added a commit to costrouc/python-package-template that referenced this issue May 29, 2018
@gbtami
Copy link

gbtami commented Mar 22, 2019

I still has this problem with https://github.com/gbtami/Fairy-Stockfish
See https://pypi.org/project/pyffish/
I'm on Ubuntu 18.04

import setuptools
setuptools.version
'40.8.0'
import twine
twine.version
'1.13.0'

dazza-codes pushed a commit to dazza-codes/aio-aws that referenced this issue Nov 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants