A Python client for the Bacalhau public API - https://github.com/filecoin-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/filecoin-project/bacalhau.
This Python package is automatically generated by the Swagger Codegen project:
- API version: 0.3.18.post4
- Package version: 0.3.18.post4
- Build package: io.swagger.codegen.languages.PythonClientCodegen For more information, please visit https://github.com/filecoin-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)
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 | 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 | local_events | POST /requester/local_events | Returns the node's local events related to the job-id passed in the body payload. Useful for troubleshooting. |
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 |
Documentation For Models
- BuildVersionInfo
- ComputeNodeInfo
- Deal
- Engine
- EventsRequest
- EventsResponse
- FreeSpace
- HealthInfo
- Job
- JobEvent
- JobEventDeal
- JobEventJobExecutionPlan
- JobEventRunOutput
- JobEventType
- JobExecutionPlan
- JobLocalEvent
- JobLocalEventType
- JobNodeState
- JobRequester
- JobShardState
- JobShardStateState
- JobShardingConfig
- JobSpec
- JobSpecDocker
- JobSpecLanguage
- JobSpecLanguageJobContext
- JobSpecWasm
- JobSpecWasmEntryModule
- JobState
- JobStateType
- JobStatus
- JobStatusJobState
- LabelSelectorRequirement
- LabelSelectorRequirementOperator
- ListRequest
- ListResponse
- LocalEventsRequest
- LocalEventsResponse
- Metadata
- MountStatus
- Network
- NetworkConfig
- NodeInfo
- NodeType
- PeerAddrInfo
- PublishedResult
- Publisher
- ResourceUsageConfig
- ResourceUsageData
- ResultsResponse
- RunCommandResult
- SelectionOperator
- Spec
- SpecDeal
- SpecDocker
- SpecEngine
- SpecExecutionPlan
- SpecNetwork
- SpecPublisher
- SpecResources
- SpecSharding
- StateRequest
- StateResponse
- StorageSourceType
- StorageSpec
- StorageSpecStorageSource
- 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.18.post4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf8d179f6ed7f6e7ba871913f8c047267aa1f0429aa3fd1e5090450982f68971 |
|
MD5 | f48cd4fa588d29a6be744e80c391170c |
|
BLAKE2b-256 | d0a7e8fccf20195d71e56f2da29bd42f43e34c49a9400a135f6d34f56551f62c |
Hashes for bacalhau_apiclient-0.3.18.post4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26fda492e05b6112cc666f94db454c499575e99719f13b400a171f0015e9911d |
|
MD5 | 2beadea7564ba3942eb0b797138079ce |
|
BLAKE2b-256 | 09731cd8099a105354ca824da5bc0d2efc7ec6bbdbdc36a0c02653a6489d5212 |