Use readme file as long description in setup file #158
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change uses the
README.md
contents aslong_description
insetuptools.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 andtwine>=1.11.0
must be used to upload them. You can see here for more information.