search

move-coop / parsons

A python library of connectors for the progressive community.
Other
255 stars 125 forks source link

PyPi Page Does Not Detect README.md #944

Closed Jason94 closed 2 months ago

Jason94 commented 7 months ago

Currently the Parsons PyPi page has a blank description. This looks unprofessional, and might cause confusion for potential users trying to learn about Parsons. It's easy to configure the Python build system to use the GitHub readme file as the PyPi description.

If we add this code to our setup.py file, it should have the PyPi page use the README.md file as the description: https://packaging.python.org/en/latest/guides/making-a-pypi-friendly-readme/.


# read the contents of your README file
from pathlib import Path
this_directory = Path(__file__).parent
long_description = (this_directory / "README.md").read_text()

setup(
    name='an_example_package',
    # other arguments omitted
    long_description=long_description,
    long_description_content_type='text/markdown'
)
shaunagm commented 2 months ago

This was fixed in the most recent release.