A Python Wrapper around the Starburst REST APIs
This is not part of the core Starburst product and is not covered by Starburst support agreements. It is a community developed set of scripts to make your life easier when working with Starburst APIs.
This Python package is a wrapper around the Starburst REST API as documented here:
- Starburst Enterprise: https://docs.starburst.io/latest/api/index.htm
- Starburst Galaxy: https://galaxy.starburst.io/public-api
The motivation behind this project comes from the demand I see at customers to use the API for automation purposes. However, working with the raw API is not as easy as it might sound in theory. Therefore, I wanted to try it out myself in a small project. I quickly saw the need to wrap the actual API into easy to use functions and this library is the result.
Releases are not yet available on PyPI, but you can install using pip nonetheless:
python -m pip install -U pip
python -m pip install -U pip install git+https://github.com/ottensa/adastra.gitad astra allows you to interact easily with the Starburst Enterprise REST API. It abstracts away the complexity of the raw API.
# Starburst Galaxy
from adastra.client import GalaxyClient
client = GalaxyClient(host='https://example.galaxy.starburst.io', client_id='clientid', client_secret='clientsecret')
data_products_service = client.data_product_service()
list_of_data_products = data_products_service.list()
...
# Starburst Enterprise
from adastra.client import SepClient
client = SepClient(host='https://sep.example.com', user='someuser', token='Some: Token')
data_products_service = client.data_product_service()
list_of_data_products = data_products_service.list()- This package does not claim to be complete and currently only focuses on Data Products.
- It has only be tested with Basic Authentication so far.
ad astra is Latin and means to the stars.
That is already a great name for something in the context of Starburst with its space theme. And it gets even better as it forms a nice acronym as well:
ad a STarburst Rest Api or to a Starburst Rest Api
What could be a better name for something that lets you connect to a Starburst REST API? 😄
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
Distributed under the MIT License. See LICENSE for more information.