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

Use readme file as long description in setup file #158

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Use readme file as long description in setup file #158

wants to merge 2 commits into from

Conversation

ghost
Copy link

@ghost ghost commented May 5, 2018

This change uses the README.md contents as long_description in setuptools.setup call so that the project description is available on PyPI. Currently, the project on PyPI shows no description at all: https://pypi.org/project/lambda-uploader.

The redundant readme file is also removed. The .rst version was removed since it was missing one section that was in the .md version (the subscription configuration section). Because of this, it was assumed that the markdown version was the preferred one. It will be much easier to maintain only one readme file.

It is important to note that in order to correctly display the markdown formatted description on PyPI, setuptools>=38.6.0 must be used to create the builds and twine>=1.11.0 must be used to upload them. You can see here for more information.

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

Successfully merging this pull request may close these issues.

0 participants