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

Required fixes for release #15

Merged
merged 6 commits into from
Jun 28, 2022
Merged

Conversation

phackstock
Copy link
Contributor

@phackstock phackstock commented Jun 27, 2022

Changes

There were two fixed required for building and releasing this package on pypi.

  • There was an undefined rst directive in the README.rst file, causing test pypi to reject the upload.
  • Because of the (side)-effect of 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 where manifest.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 added
  • Documentation added
  • Example added (in the documentation, to an existing notebook, or in a new notebook)
  • Description in CHANGELOG.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.

@phackstock phackstock requested review from znicholls and jkikstra June 27, 2022 15:01
@phackstock phackstock self-assigned this Jun 27, 2022
Copy link
Collaborator

@znicholls znicholls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, we'll learn more once we try in the wild but I think this is the right next step

@phackstock phackstock merged commit ec8f9bd into iiasa:main Jun 28, 2022
@phackstock phackstock deleted the feature/release-fixes branch June 28, 2022 07:16
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.

2 participants