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

Extend bioblend to support the new notification API #471

Open
15 tasks done
heisner-tillman opened this issue Jun 6, 2023 · 3 comments
Open
15 tasks done

Extend bioblend to support the new notification API #471

heisner-tillman opened this issue Jun 6, 2023 · 3 comments

Comments

@heisner-tillman
Copy link

heisner-tillman commented Jun 6, 2023

This makes use of the new Notification System, which is available since the 23_01 release of Galaxy.

List of operations to add:

  • get_notifications_status
  • send_notification
  • get_notification_preferences
  • update_notification_preferences
  • get_user_notifications
  • get_broadcasted
  • get_all_broadcasted
  • show_notification
  • update_broadcasted_notification
  • update_user_notification
  • update_user_notifications
  • delete_user_notification
  • delete_user_notifications
  • broadcast_notification

Testing

  • Add automated tests for all operations

Galaxy API

You can find the interactive documentation for the Notification System here: : https://usegalaxy.eu/api/docs#/notifications

@heisner-tillman
Copy link
Author

heisner-tillman commented Jun 29, 2023

The bioblend operations in regards to the Notification-API only work with Galaxy version >= 23.1. Is there a way to make them inaccessible if the Galaxy version is older?

@test_util.skip_unless_galaxy("release_23.1")
I found this for the tests. Is there something like this for the operations?

@nsoranzo
Copy link
Member

The bioblend operations in regards to the Notification-API only work with Galaxy version >= 23.1. Is there a way to make them inaccessible if the Galaxy version is older?

I don't think that's necessary.

@test_util.skip_unless_galaxy("release_23.1") I found this for the tests. Is there something like this for the operations?

You can add a note to the class or method docstrings, see e.g. https://github.com/galaxyproject/bioblend/blob/main/bioblend/galaxy/jobs/__init__.py#L229-L230

@heisner-tillman
Copy link
Author

heisner-tillman commented Jun 30, 2023

You can add a note to the class or method docstrings

I have done this.

@nsoranzo
All the tests run successfully and tox -e lint throws no check-style errors.
Can u tell me if there is something that needs to be done before merging the pull request?

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

No branches or pull requests

2 participants