This is the official Python SDK for Bacalhau, named bacalhau-sdk
.
It is a high-level SDK that ships the client-side logic (e.g. signing requests) needed to query the endpoints. Please take a look at the examples for snippets to create, list and inspect jobs. Under the hood, this SDK uses bacalhau-apiclient
(autogenerated via Swagger/OpenAPI) to interact with the API.
Please make sure to use this SDK library in your Python projects, instead of the lower level bacalhau-apiclient
. The latter is listed as a dependency of this SDK and will be installed automatically when you follow the installation instructions below.
Use the production network, or set the following environment variables to target any Bacalhau network out there:
BACALHAU_API_HOST
BACALHAU_API_PORT
Generate a key pair used to sign requests stored in the path specified by the BACALHAU_DIR
env var (default: ~/.bacalhau
)
Clone the public repository:
Once you have a copy of the source, you can install it with:
Likewise the Bacalhau CLI, this SDK uses a key pair to be stored in BACALHAU_DIR
used for signing requests. If a key pair is not found there, it will create one for you.
Let's submit a Hello World job and then fetch its output data's CID. We start by importing this sdk, namely bacalhau_sdk
, used to create and submit a job create request. Then we import bacalhau_apiclient
(installed automatically with this sdk), it provides various object models that compose a job create request. These are used to populate a simple python dictionary that will be passed over to the submit
util method.
The script above prints the following object, the job.metadata.id
value is our newly created job id!
We can then use the results
method to fetch, among other fields, the output data's CID.
The line above prints the following dictionary:
Congrats, that was a good start! 🎈 Please find more code snippets in the examples folder (more examples published in the near future).
You can set the environment variables BACALHAU_API_HOST
and BACALHAU_API_PORT
to point this SDK to your Bacalhau API local devstack
We use Poetry to manage this package, take a look at their official docs to install it. Note, all targets in the Makefile use poetry as well!
To develop this SDK locally, create a dedicated poetry virtual environment and install the root package (i.e. bacalhau_sdk
) and its dependencies:
Note the line above installs the root package (i.e. bacalhau_sdk
) in editable mode, that is, any change to its source code is reflected immediately without the need for re-packaging and re-installing it. Easy peasy!
Then install the pre-commit hooks and test it:
List, create and inspect Bacalhau jobs using Python objects