bacalhau-apiclient

v1.4.1

A Python client for the Bacalhau public API - https://github.com/bacalhau-project/bacalhau/tree/main/clients/python For more information about how to use this package see README

Latest version published 5 months ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

75 / 100

security
No known security issues
popularity
Recognized
maintenance
Sustainable
community
Sustainable

Popularity

Recognized

GitHub Stars: 704
Forks: 89
Contributors: 60

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package bacalhau-apiclient, we found that it has been starred 704 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jul 4, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like bacalhau-apiclient is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 197
Open PR: 4
Last Release: 5 months ago
Last Commit: 7 days ago

Further analysis of the maintenance status of bacalhau-apiclient based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that bacalhau-apiclient demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 60
Funding: No

With more than 10 contributors for the bacalhau-apiclient repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like bacalhau-apiclient is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 2 years
Latest Release: 5 months ago
Dependencies: N/A
Versions: 33
Maintainers: 1
Wheels: OS Independent

Readme

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

FAQs

What is bacalhau-apiclient?

A Python client for the Bacalhau public API - https://github.com/bacalhau-project/bacalhau/tree/main/clients/python. Visit Snyk Advisor to see a full health score report for bacalhau-apiclient, including popularity, security, maintenance & community analysis.

Is bacalhau-apiclient popular?

The python package bacalhau-apiclient receives a total of 1,035 weekly downloads. As such, bacalhau-apiclient popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is bacalhau-apiclient well maintained?

We found indications that bacalhau-apiclient maintenance is sustainable demonstrating some project activity. We saw a total of 60 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is bacalhau-apiclient safe to use?

The python package bacalhau-apiclient was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 November-2024, at 16:16 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP