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.
Changes
There were two fixed required for building and releasing this package on pypi.
README.rst
file, causing test pypi to reject the upload.setuptools_scm
it adds all files under version control to the package. This is not desired behavior as in this case it would include all tests. This would bring the package size beyond the limit of pypi. This is wheremanifest.in
comes in handy as it allows us to remove the tests folder from the final package. Right now I have placed all files and folders in there that seemed sensible to me, if you @jkikstra and @znicholls have suggestions for additional files that are not needed I'd be happy to add them.Not sure if the point about tests applies in this case.
I added documentation about installation to the README.rst and the docs.
Tests addedCHANGELOG.rst
added (single line such as:(`#XX <https://github.com/iiasa/climate-assessment/pull/XX>`_) Added feature which does something
)After merging this PR we should be good to release on pypi.