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 updated papermill v0.16 API #10

Merged
merged 3 commits into from
Apr 6, 2019

Conversation

matthewfeickert
Copy link
Owner

@matthewfeickert matthewfeickert commented Apr 6, 2019

Description

Use the updated papermill v0.16 API that uses output_path instead of output. Also require papermill to be compatible with v0.16 by using PEP 440/508's compatible version syntax. This ensures that the API should be stable as it will remain at v0.Y versions even after major release v1.Y.Z is released.

This also has the nice feature of being able to intentionally choose when to update to a newer backend API even if the backend has had a new major release with API breaking changes for a long time.

Noting that if the release is specified down to the bug fix release (X.Y.Z) then it will be pinned down to the minor release (X.Y). c.f. PEP 404:

the following groups of version clauses are equivalent:

~= 1.4.5
>= 1.4.5, == 1.4.*

so as updates from other libraries are desirable, as long as there is no API breaking changes, then all dependencies should be specified as

~= X.Y

unless they need to be specified all the way down to X.Y.*

c.f.

- Use updated papermill `v0.16` API
- Require papermill version compatible with v0.16 by using PEP 440/508's compatible version syntax
- Add pip freeze to Travis to make viewing the environment easier

Use the updated papermill v0.16 API that used output_path instead of
output
Require papermill to be compatible with v0.16 by using PEP 440/508's
compatible version syntax. This ensures that the API should be stable as
it will remain at v0.Y versions even after major release v1.Y.Z is
released

c.f.
 - https://www.python.org/dev/peps/pep-0440/#compatible-release
 - https://www.python.org/dev/peps/pep-0508
@matthewfeickert matthewfeickert self-assigned this Apr 6, 2019
pip freeze make is easier to see what the environment is from the build
logs
@matthewfeickert matthewfeickert merged commit 8ccf88e into master Apr 6, 2019
@matthewfeickert matthewfeickert deleted the revise/update-papermill-API branch April 6, 2019 21:37
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.

1 participant