View markdown source on GitHub

Scripting Galaxy using the API and BioBlend

Contributors

Questions

Requirements

last_modification Published: Jan 1, 1970
last_modification Last Updated: Apr 17, 2024

Galaxy API

Speaker Notes


Interacting with Galaxy: UI vs. API

Speaker Notes


Galaxy API functionalities

Speaker Notes


RESTful API

.left[REpresentational State Transfer (REST) is the architectural style of the World Wide Web:]

Speaker Notes


API requests

Speaker Notes


API requests

Speaker Notes


JSON format

.left[JavaScript Object Notation https://www.json.org/] JSON logo

{"history_id": "b5731bb49a17bf50",
 "id": "df06cc665d85b6ea",
 "inputs": {"0": {"id": "bbd44e69cb8906b51528b5d606d1fdd0",
                  "src": "hda"}},
 "model_class": "WorkflowInvocation",
 "outputs": ["bbd44e69cb8906b528819eaaff340ecd",
             "0ff30b4e2a4bed9e"],
 "state": "scheduled",
 "update_time": "2015-07-03T19:28:39.544574",
 "workflow_id": "56482e194d798eb6"}

Speaker Notes


Status codes and errors

Speaker Notes


How to access a REST API

.left[With anything that can communicate over HTTP:]

Speaker Notes


Security

Speaker Notes


Advanced Galaxy API config

.left[Options in config/galaxy.yml:]

Speaker Notes


Galaxy API Modernization

.left[Moving to FastAPI]

Speaker Notes


Galaxy API pros and cons

Speaker Notes


BioBlend

Speaker Notes


BioBlend features

Speaker Notes


BioBlend limitations

Speaker Notes


BioBlend.objects

Speaker Notes


References

Speaker Notes


Key Points

Thank you!

This material is the result of a collaborative work. Thanks to the Galaxy Training Network and all the contributors! Galaxy Training Network Tutorial Content is licensed under Creative Commons Attribution 4.0 International License.