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

Add README to setup.py description #397

Closed
djhoese opened this issue Aug 19, 2018 · 1 comment
Closed

Add README to setup.py description #397

djhoese opened this issue Aug 19, 2018 · 1 comment

Comments

@djhoese
Copy link
Member

djhoese commented Aug 19, 2018

The PyPI page for satpy does not include a description. From the information on the project settings page on PyPI it should come from the description field in the setup.py:

To set the 'satpy' description, author, links, classifiers, and other details for your next release, use the setup() arguments in your setup.py file. Updating these fields will not change the metadata for past releases. See the Python Packaging User Guide for more help.

https://pypi.org/project/satpy/

I think we should edit the setup.py to read the README.rst file and put it in the description field of the setup call. However, that doesn't explain why the current description 'Meteorological post processing package' isn't the current description of the package. Any ideas?

@djhoese
Copy link
Member Author

djhoese commented Aug 19, 2018

Ah it must be the long_description https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py

djhoese added a commit to djhoese/satpy that referenced this issue Oct 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant