A Python client for the Bacalhau public API - https://github.com/bacalhau-project/bacalhau/tree/main/clients/python
Project description
bacalhau_apiclient
This page is the reference of the Bacalhau REST API. Project docs are available at https://docs.bacalhau.org/. Find more information about Bacalhau at https://github.com/bacalhau-project/bacalhau.
This Python package is automatically generated by the Swagger Codegen project:
- API version: ${PYPI_VERSION}
- Package version: 0.3.29
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen For more information, please visit https://github.com/bacalhau-project/bacalhau
Requirements.
Python 3.6+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import bacalhau_apiclient
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import bacalhau_apiclient
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import bacalhau_apiclient
from bacalhau_apiclient.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = bacalhau_apiclient.HealthApi(bacalhau_apiclient.ApiClient(configuration))
try:
# Returns debug information on what the current node is doing.
api_response = api_instance.api_serverdebug()
pprint(api_response)
except ApiException as e:
print("Exception when calling HealthApi->api_serverdebug: %s\n" % e)
# create an instance of the API class
api_instance = bacalhau_apiclient.HealthApi(bacalhau_apiclient.ApiClient(configuration))
try:
# Returns debug information on what the current node is doing.
api_response = api_instance.debug()
pprint(api_response)
except ApiException as e:
print("Exception when calling HealthApi->debug: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://bootstrap.production.bacalhau.org:1234/
Class | Method | HTTP request | Description |
---|---|---|---|
HealthApi | api_serverdebug | GET /debug | Returns debug information on what the current node is doing. |
HealthApi | debug | GET /requester/debug | Returns debug information on what the current node is doing. |
JobApi | cancel | POST /requester/cancel | Cancels the job with the job-id specified in the body payload. |
JobApi | events | POST /requester/events | Returns the events related to the job-id passed in the body payload. Useful for troubleshooting. |
JobApi | list | POST /requester/list | Simply lists jobs. |
JobApi | logs | POST /requester/logs | Displays the logs for a current job/execution |
JobApi | results | POST /requester/results | Returns the results of the job-id specified in the body payload. |
JobApi | states | POST /requester/states | Returns the state of the job-id specified in the body payload. |
JobApi | submit | POST /requester/submit | Submits a new job to the network. |
MiscApi | api_serverversion | POST /version | Returns the build version running on the server. |
UtilsApi | healthz | GET /healthz | |
UtilsApi | id | GET /id | Returns the id of the host node. |
UtilsApi | livez | GET /livez | |
UtilsApi | logz | GET /logz | |
UtilsApi | node_info | GET /node_info | Returns the info of the node. |
UtilsApi | peers | GET /peers | Returns the peers connected to the host via the transport layer. |
UtilsApi | readyz | GET /readyz | |
UtilsApi | varz | GET /varz | |
DefaultApi | api_serverapprover | GET /approve | Approves a job to be run on this compute node. |
Documentation For Models
- AllOfExecutionStateRunOutput
- AllOfExecutionStateState
- AllOfJobCreatePayloadSpec
- AllOfJobSpec
- AllOfJobSpecLanguageJobContext
- AllOfJobSpecWasmEntryModule
- AllOfJobStateState
- AllOfJobWithInfoJob
- AllOfJobWithInfoState
- AllOfLabelSelectorRequirementOperator
- AllOfSpecDeal
- AllOfSpecDocker
- AllOfSpecEngine
- AllOfSpecNetwork
- AllOfSpecPublisher
- AllOfSpecResources
- AllOfStorageSpecStorageSource
- AllOfcancelRequestPayload
- AllOfeventsRequestFilters
- AllOflogRequestPayload
- AllOfsubmitRequestPayload
- BuildVersionInfo
- CancelRequest
- CancelResponse
- ComputeNodeInfo
- Deal
- Engine
- EventFilterOptions
- EventsRequest
- EventsResponse
- ExecutionState
- ExecutionStateType
- FreeSpace
- HealthInfo
- Job
- JobCancelPayload
- JobCreatePayload
- JobHistory
- JobHistoryType
- JobRequester
- JobSpecDocker
- JobSpecLanguage
- JobSpecWasm
- JobState
- JobStateType
- JobWithInfo
- LabelSelectorRequirement
- ListRequest
- ListResponse
- LogRequest
- LogsPayload
- Metadata
- MountStatus
- Network
- NetworkConfig
- NodeInfo
- NodeType
- PeerAddrInfo
- PublishedResult
- Publisher
- PublisherSpec
- ResourceUsageConfig
- ResourceUsageData
- ResultsResponse
- RunCommandResult
- S3StorageSpec
- SelectionOperator
- Spec
- StateChangeExecutionStateType
- StateChangeJobStateType
- StateRequest
- StateResponse
- StorageSourceType
- StorageSpec
- SubmitRequest
- SubmitResponse
- VerificationResult
- Verifier
- VersionRequest
- VersionResponse
Documentation For Authorization
All endpoints do not require authorization.
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bacalhau_apiclient-0.3.29.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63243b4bb14de092b54259cc786b5c061c0e855e2626c69231c9c65e823f2015 |
|
MD5 | e21ac5c50443dfb5dc5e6a1bf6fd83ac |
|
BLAKE2b-256 | b8aaaadb163b7b535056997ca826c5ff65549319c62f9af4ee091375a2d25ed7 |
Hashes for bacalhau_apiclient-0.3.29-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 376093e3ddb4a9ebe413044e6bcd3acf891bd4e7c91695cedcfb336907be7084 |
|
MD5 | f5213c395ea084aab3a55f52d4da4c9b |
|
BLAKE2b-256 | 3bbad5d504d5fda3197615229f6e2a64143fd382656e0298c23d7763330850ca |