This release is a pre-release and may not be stable for production use.
EnclaveSDK
Described below is the EscrowAI Enclave API that provides functionality inside a BeeKeeperAI environment. Included are data engineering endpoints and reporting endpoints.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 2.1.4
- Package version: 2.1.4.dev55161
- Generator version: 7.17.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.9+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
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 EnclaveSDK
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 EnclaveSDK
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import EnclaveSDK
from EnclaveSDK.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://sandbox.dev.escrow.beekeeperai.com
# See configuration.py for a list of all supported configuration parameters.
configuration = EnclaveSDK.Configuration(
host="http://sandbox.dev.escrow.beekeeperai.com"
)
# Enter a context with an instance of the API client
with EnclaveSDK.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = EnclaveSDK.AuthApi(api_client)
auth_request = EnclaveSDK.AuthRequest() # AuthRequest |
try:
# Authenticate and return server configuration
api_response = api_instance.api_v1_auth_post(auth_request)
print("The response of AuthApi->api_v1_auth_post:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AuthApi->api_v1_auth_post: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://sandbox.dev.escrow.beekeeperai.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AuthApi | api_v1_auth_post | POST /api/v1/auth | Authenticate and return server configuration |
| DataApi | api_v1_data_file_get | GET /api/v1/data/file | Retrieve a file by its filename and optionally SASUrl as a get request |
| DataApi | api_v1_data_file_post | POST /api/v1/data/file | Retrieve a file by its filename and optionally SASUrl as a post request |
| DataApi | api_v1_data_files_get | GET /api/v1/data/files | Retrieve a list of available files |
| DataApi | api_v1_data_sql_select_post | POST /api/v1/data/sql/select | Execute a SQL query |
| EscrowApi | api_v1_ping_attestation_get | GET /api/v1/ping/attestation | Ping attestation authority |
| EscrowApi | api_v1_ping_drain_get | GET /api/v1/ping/drain | Check if EnclaveAPI is fully drained and safe to shutdown |
| EscrowApi | api_v1_ping_enclave_get | GET /api/v1/ping/enclave | Ping to check if the enclave API is up |
| EscrowApi | api_v1_ping_escrow_get | GET /api/v1/ping/escrow | Ping to check if the backend Escrow service is up |
| EscrowApi | api_v1_ping_kms_get | GET /api/v1/ping/kms | Ping key manager |
| LogApi | api_v1_log_post | POST /api/v1/log | Post log data |
| MlflowApi | api20_mlflow_artifacts_artifact_path_delete | DELETE /api/2.0/mlflow-artifacts/{artifactPath} | Proxy DELETE request to MLflow Artifacts |
| MlflowApi | api20_mlflow_artifacts_artifact_path_get | GET /api/2.0/mlflow-artifacts/{artifactPath} | Proxy GET request to MLflow Artifacts |
| MlflowApi | api20_mlflow_artifacts_artifact_path_post | POST /api/2.0/mlflow-artifacts/{artifactPath} | Proxy POST request to MLflow Artifacts |
| MlflowApi | api20_mlflow_artifacts_artifact_path_put | PUT /api/2.0/mlflow-artifacts/{artifactPath} | Proxy PUT request to MLflow Artifacts |
| MlflowApi | api20_mlflow_proxy_path_delete | DELETE /api/2.0/mlflow/{proxyPath} | Proxy DELETE request to MLflow |
| MlflowApi | api20_mlflow_proxy_path_get | GET /api/2.0/mlflow/{proxyPath} | Proxy GET request to MLflow |
| MlflowApi | api20_mlflow_proxy_path_post | POST /api/2.0/mlflow/{proxyPath} | Proxy POST request to MLflow |
| MlflowApi | api20_mlflow_proxy_path_put | PUT /api/2.0/mlflow/{proxyPath} | Proxy PUT request to MLflow |
| ReportApi | api_v1_report_artifact_post | POST /api/v1/report/artifact | Upload a report artifact (image or video) |
| ReportApi | api_v1_report_post | POST /api/v1/report | Post a valid report |
| ReportApi | api_v1_validate_post | POST /api/v1/validate | Validate a report |
| RunApi | api_v1_algorithm_status_post | POST /api/v1/algorithm/status | Log the status of an algorithm execution |
| WritebackApi | api_v1_writeback_file_delete | DELETE /api/v1/writeback/file | Delete a writeback file |
| WritebackApi | api_v1_writeback_file_get | GET /api/v1/writeback/file | Retrieve a writeback file |
| WritebackApi | api_v1_writeback_file_post | POST /api/v1/writeback/file | Create a writeback file |
| WritebackApi | api_v1_writeback_file_put | PUT /api/v1/writeback/file | Upsert a writeback file |
| WritebackApi | api_v1_writeback_files_get | GET /api/v1/writeback/files | Retrieve a list of available writeback files |
Documentation For Models
- AlgorithmStatus
- ApiV1DataFilesGet200Response
- ApiV1LogPost200Response
- ArtifactResponse
- AuthRequest
- BasicMessage
- File
- LogData
- PingAttestationStatus
- PingDrainStatus
- PingEnclaveStatus
- PingEscrowStatus
- PingKeyManagerStatus
- Report
- ReportJsonSchema
- RequestFileData
- SASObject
- SASObjectS3Config
- SQLQuery
- SQLResponse
- ServerConfig
- ValidationResult
- WriteFileRequest
- WriteFileResponse
Documentation For Authorization
Authentication schemes defined for the API:
BearerAuth
- Type: Bearer authentication
Author
Metadata
Release files for EnclaveSDK 2.1.4.dev55161
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| enclavesdk-2.1.4.dev55161-py3-none-any.whl | Python 3 | none | any | Details |
Release files / enclavesdk-2.1.4.dev55161-py3-none-any.whl
| Download URL | enclavesdk-2.1.4.dev55161-py3-none-any.whl |
|---|---|
| Size | 79.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7cc737e006e7b0bc03699351b02c0b4f9fe9a4db7d9a6b954d21eabc2ed3246c
|
|
BLAKE2b-256 checksum How to use checksums |
f27c78f438e65bad772c09f0218c6741f2fe327ba68a75d21fad128033ea9a09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Security for EnclaveSDK 2.1.4.dev55161
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.