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: ${VERSION}
Package version:
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.ComputeNodeApi(bacalhau_apiclient.ApiClient(configuration))

try:
    # Approves a job to be run on this compute node.
    api_response = api_instance.api_serverapprover()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ComputeNodeApi->api_serverapprover: %s\n" % e)

# create an instance of the API class
api_instance = bacalhau_apiclient.ComputeNodeApi(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 ComputeNodeApi->api_serverdebug: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://bootstrap.production.bacalhau.org:1234/

Class	Method	HTTP request	Description
ComputeNodeApi	api_serverapprover	GET /api/v1/compute/approve	Approves a job to be run on this compute node.
ComputeNodeApi	api_serverdebug	GET /api/v1/compute/debug	Returns debug information on what the current node is doing.
MiscApi	api_serverversion	POST /api/v1/version	Returns the build version running on the server.
OpsApi	agentalive	GET /api/v1/agent/alive
OpsApi	agentdebug	GET /api/v1/agent/debug	Returns debug information on what the current node is doing.
OpsApi	agentnode	GET /api/v1/agent/node	Returns the info of the node.
OpsApi	agentversion	GET /api/v1/agent/version	Returns the build version running on the server.
OrchestratorApi	orchestratorget_job	GET /api/v1/orchestrator/jobs/{id}	Returns a job.
OrchestratorApi	orchestratorget_node	GET /api/v1/orchestrator/nodes/{id}	Get an orchestrator node
OrchestratorApi	orchestratorjob_executions	GET /api/v1/orchestrator/jobs/{id}/executions	Returns the executions of a job.
OrchestratorApi	orchestratorjob_history	GET /api/v1/orchestrator/jobs/{id}/history	Returns the history of a job.
OrchestratorApi	orchestratorjob_results	GET /api/v1/orchestrator/jobs/{id}/results	Returns the results of a job.
OrchestratorApi	orchestratorlist_jobs	GET /api/v1/orchestrator/jobs	Returns a list of jobs.
OrchestratorApi	orchestratorlist_nodes	GET /api/v1/orchestrator/nodes	Returns a list of orchestrator nodes.
OrchestratorApi	orchestratorlogs	GET /api/v1/orchestrator/jobs/{id}/logs	Displays the logs for a current job/execution
OrchestratorApi	orchestratorput_job	PUT /api/v1/orchestrator/jobs	Submits a job to the orchestrator.
OrchestratorApi	orchestratorstop_job	DELETE /api/v1/orchestrator/jobs/{id}	Stops a job.
OrchestratorApi	orchestratorupdate_node	POST /api/v1/orchestrator/nodes	Update an orchestrator node.
UtilsApi	healthz	GET /api/v1/healthz
UtilsApi	home	GET /
UtilsApi	id	GET /api/v1/id	Returns the id of the host node.
UtilsApi	livez	GET /api/v1/livez
UtilsApi	node_info	GET /api/v1/node_info	Returns the info of the node.

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

team@bacalhau.org

Metadata

Release files for bacalhau-apiclient 1.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bacalhau-apiclient 1.4.1
File	Size	Uploaded
bacalhau_apiclient-1.4.1.tar.gz	60.3 kB	Jul 4, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for bacalhau-apiclient 1.4.1
File	Interpreter	ABI	Platform	Reset
bacalhau_apiclient-1.4.1-py3-none-any.whl 129.5 kB Jul 4, 2024	Python 3	none	any	Details

Total release size: 189.8 kB

Release files / bacalhau_apiclient-1.4.1.tar.gz

Download URL	bacalhau_apiclient-1.4.1.tar.gz
Size	60.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`f06831c8e069a98cda6a705b5fe573ae4d031110186e5fea41178d26f1a0c86e`
BLAKE2b-256 checksum How to use checksums	`2d3058be8e26393fb61a78cdc03181bb45e3d54af576a31f647fd63997c99534`
Upload date	Jul 4, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.10.14`

Release files / bacalhau_apiclient-1.4.1-py3-none-any.whl

Download URL	bacalhau_apiclient-1.4.1-py3-none-any.whl
Size	129.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`745d4f0c37b4d67d412489453144e5d0514983eb5cc218fe7215ea01665ff84c`
BLAKE2b-256 checksum How to use checksums	`dcf0223e4ea5e23432aa48f189790f7219013a30553b399b446a7020c3a0ec81`
Upload date	Jul 4, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.10.14`