Skip to content

Add readme.rst as long description on PyPi #13

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

Closed
uvchik opened this issue Mar 15, 2018 · 4 comments
Closed

Add readme.rst as long description on PyPi #13

uvchik opened this issue Mar 15, 2018 · 4 comments
Assignees
Labels
Milestone

Comments

@uvchik
Copy link
Member

uvchik commented Mar 15, 2018

In the release of v0.0.5 the README.rst file is interpreted as long description for the pypi page. Due to changes on the pypi-page this is not the case for v0.0.6.

Have a look at the setup.py file of oemof to see how we solved this issue for oemof by adding a long_description parameter to the setup call. This should automatically use the actual README.rst as long description on pypi if a release is uploaded. Therefore, we should fix it before the next release.

@uvchik uvchik added the bug label Mar 15, 2018
@uvchik uvchik added this to the v0.0.7 milestone Mar 15, 2018
@SabineHaas SabineHaas modified the milestones: v0.0.7, v0.1.0 Dec 12, 2018
@SabineHaas
Copy link
Member

Thank you Uwe! I added the parameter.

@uvchik
Copy link
Member Author

uvchik commented Jan 4, 2019

Did you check the rendering?

pip install readme_renderer
python setup.py check -r -s

@SabineHaas
Copy link
Member

Did you check the rendering?

pip install readme_renderer
python setup.py check -r -s

"The project's long description is valid RST."

However, I read here that this might not guarantee that it works. Do you know whether there is any other check?

@uvchik
Copy link
Member Author

uvchik commented Jan 4, 2019

Do you know whether there is any other check?

No. Let's hope 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants