Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/speakeasy-sdks/bac-test
A Python SDK for accessing the bac-test API.
https://github.com/speakeasy-sdks/bac-test
Last synced: 2 days ago
JSON representation
A Python SDK for accessing the bac-test API.
- Host: GitHub
- URL: https://github.com/speakeasy-sdks/bac-test
- Owner: speakeasy-sdks
- License: mit
- Created: 2023-08-09T16:42:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T21:44:06.000Z (7 months ago)
- Last Synced: 2024-04-28T05:14:37.522Z (6 months ago)
- Language: Python
- Homepage:
- Size: 476 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# bac-test
## SDK Installation
```bash
pip install git+https://github.com/speakeasy-sdks/bac-test.git
```
## SDK Example Usage
### Example
```python
import bac
s = bac.Bac()
res = s.job.approve()
if res.success is not None:
# handle response
pass
```
## Available Resources and Operations
### [job](docs/sdks/job/README.md)
* [approve](docs/sdks/job/README.md#approve) - Approves a job to be run on this compute node.
* [cancel](docs/sdks/job/README.md#cancel) - Cancels the job with the job-id specified in the body payload.
* [submit](docs/sdks/job/README.md#submit) - Submits a new job to the network.
### [debug](docs/sdks/debug/README.md)
* [get](docs/sdks/debug/README.md#get) - Returns debug information on what the current node is doing.
### [healthz](docs/sdks/healthz/README.md)
* [get](docs/sdks/healthz/README.md#get)
### [host_node_id](docs/sdks/hostnodeid/README.md)
* [get](docs/sdks/hostnodeid/README.md#get) - Returns the id of the host node.
### [livez](docs/sdks/livez/README.md)
* [get](docs/sdks/livez/README.md#get)
### [logz](docs/sdks/logz/README.md)
* [get](docs/sdks/logz/README.md#get)
### [node_info](docs/sdks/nodeinfo/README.md)
* [get](docs/sdks/nodeinfo/README.md#get) - Returns the info of the node.
### [connected_peers](docs/sdks/connectedpeers/README.md)
* [get](docs/sdks/connectedpeers/README.md#get) - Returns the peers connected to the host via the transport layer.
### [readyz](docs/sdks/readyz/README.md)
* [get](docs/sdks/readyz/README.md#get)
### [requester_debug](docs/sdks/requesterdebug/README.md)
* [get](docs/sdks/requesterdebug/README.md#get) - Returns debug information on what the current node is doing.
### [job_events](docs/sdks/jobevents/README.md)
* [get](docs/sdks/jobevents/README.md#get) - Returns the events related to the job-id passed in the body payload. Useful for troubleshooting.
### [jobs](docs/sdks/jobs/README.md)
* [list](docs/sdks/jobs/README.md#list) - Simply lists jobs.
### [job_logs](docs/sdks/joblogs/README.md)
* [display](docs/sdks/joblogs/README.md#display) - Displays the logs for a current job/execution
### [nodes](docs/sdks/nodes/README.md)
* [display](docs/sdks/nodes/README.md#display) - Displays the nodes that this requester knows about
### [results](docs/sdks/results/README.md)
* [get](docs/sdks/results/README.md#get) - Returns the results of the job-id specified in the body payload.
### [states](docs/sdks/states/README.md)
* [get](docs/sdks/states/README.md#get) - Returns the state of the job-id specified in the body payload.
### [varz](docs/sdks/varz/README.md)
* [get](docs/sdks/varz/README.md#get)
### [build_version](docs/sdks/buildversion/README.md)
* [get](docs/sdks/buildversion/README.md#get) - Returns the build version running on the server.
## Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
| Error Object | Status Code | Content Type |
| -------------------------- | -------------------------- | -------------------------- |
| errors.BadRequest | 400 | application/json |
| errors.Forbidden | 403 | application/json |
| errors.InternalServerError | 500 | application/json |
| errors.SDKError | 4x-5xx | */* |
### Example
```python
import bac
from bac.models import errors
s = bac.Bac()
res = None
try:
res = s.job.approve()
except errors.BadRequest as e:
# handle exception
raise(e)
except errors.Forbidden as e:
# handle exception
raise(e)
except errors.InternalServerError as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res.success is not None:
# handle response
pass
```
## Server Selection
### Select Server by Index
You can override the default server globally by passing a server index to the `server_idx: int` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
| - | ------ | --------- |
| 0 | `http://bootstrap.production.bacalhau.org:1234/` | None |
#### Example
```python
import bac
s = bac.Bac(
server_idx=0,
)
res = s.job.approve()
if res.success is not None:
# handle response
pass
```
### Override Server URL Per-Client
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
import bac
s = bac.Bac(
server_url="http://bootstrap.production.bacalhau.org:1234/",
)
res = s.job.approve()
if res.success is not None:
# handle response
pass
```
## Custom HTTP Client
The Python SDK makes API calls using the [requests](https://pypi.org/project/requests/) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `requests.Session` object.
For example, you could specify a header for every request that this sdk makes as follows:
```python
import bac
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = bac.Bac(client: http_client)
```
### Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.
### Contributions
While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)