Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

client version checking #1281

Closed
melange396 opened this issue Aug 24, 2023 · 2 comments · Fixed by #1456
Closed

client version checking #1281

melange396 opened this issue Aug 24, 2023 · 2 comments · Fixed by #1456
Assignees
Labels
enhancement good first issue help wanted js client changes the JavaScript client python client changes the Python client r client changes the R client

Comments

@melange396
Copy link
Collaborator

have the python, r, and javascript clients check their version against the current running version on the API server, and print a message informing the user that an update is available that may include fixes or new functionality.

a downside to this is that the version number is incremented MUCH more frequently than changes are made to the client code, so we may often be prompting updates that are pointless.

@melange396 melange396 added enhancement help wanted good first issue r client changes the R client python client changes the Python client js client changes the JavaScript client labels Aug 24, 2023
@melange396
Copy link
Collaborator Author

somewhat related to #1296

@rzats rzats self-assigned this Apr 10, 2024
@melange396
Copy link
Collaborator Author

We can probably pretty safely ignore this for the R client since it is on the chopping block in #1377 , and ignore the js client as well because it never seemed to really get much (if any!) use.

For the python client, we should make #1431 a prerequisite for this issue.

It would also make sense to do the conditional PyPI release suggested in #1296 and then check the version through pypi.org instead of using our version endpoint:

import requests
requests.get('https://pypi.org/pypi/delphi-epidata/json').json()['info']['version'] # => '4.1.20'

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
enhancement good first issue help wanted js client changes the JavaScript client python client changes the Python client r client changes the R client
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants