search

crytic / solc-select

Manage and switch between Solidity compiler versions
GNU Affero General Public License v3.0
746 stars 99 forks source link

Markdown README is not rendered correctly in PyPI #188

Closed elopez closed 1 year ago

elopez commented 1 year ago

Describe the issue:

The solc-select README that gets uploaded to PyPI is a markdown document, but due to a misconfiguration it is not rendered correctly in the PyPI site:

Screenshot 2023-06-26 at 13 32 15

I think this can be solved with adding something like long_description_content_type="text/markdown", in setup.py. You can get more information on how the README in PyPI works in this link: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/

AmitT98 commented 1 year ago

Hi @elopez ,can you give a little more clarification, as to what you actually want to do?

elopez commented 1 year ago

Hi @AmitT98, I expanded a bit on the issue now 👍

AmitT98 commented 1 year ago

Hi @elopez I would like to work on the issue, can you please assign it to me?

AmitT98 commented 1 year ago

Hi @elopez . I made the necessary changes and now it renders correctly. I created a pypitest to verify the same. Please check it here. https://test.pypi.org/project/solc-select/1.0.5/. Let me know if this is good enough, so that I can raise a PR. Query: I have increased the version to 1.0.5 as this is minor change, should this be kept same?

elopez commented 1 year ago

Awesome! Go ahead with a PR 👍 and please keep the version the same, just include the fix on it.