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

Check API version when initializing a HyP3 instance #107

Open
jhkennedy opened this issue Mar 25, 2021 · 0 comments
Open

Check API version when initializing a HyP3 instance #107

jhkennedy opened this issue Mar 25, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@jhkennedy
Copy link
Contributor

The SDK and the API are intimately tied together, and so the SDK should have some mechanism to warn users of possible incompatibilities and to upgrade their SDK.

Something that would look like:

>>> import hyp3_sdk as sdk
>>> hyp3 = sdk.HyP3()
UserWarning: Current HyP3 API version is 1.0.0 but the HyP3 SDK was build against 0.8.17.
You may want to upgrade you SDK version with either:
    python -m pip install --upgrade hyp3_sdk
or
    conda update -c conda-forge hyp3_sdk

We could use setuptools parse_version to allow for just checking major, or major.minor, version incompatibilities instead of just any different version...

@jhkennedy jhkennedy added the enhancement New feature or request label Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant