Metadata-Version: 2.4
Name: rcabench
Version: 1.0.1
Summary: RCABench API Python Client - A comprehensive root cause analysis benchmarking platform
Project-URL: Homepage, https://github.com/rcabench/rcabench
Project-URL: Documentation, https://rcabench.readthedocs.io/
Project-URL: Repository, https://github.com/rcabench/rcabench
Project-URL: Bug Tracker, https://github.com/rcabench/rcabench/issues
Project-URL: Changelog, https://github.com/rcabench/rcabench/blob/main/CHANGELOG.md
Author-email: RCABench Team <team@rcabench.com>
Maintainer-email: RCABench Team <team@rcabench.com>
License: MIT
Keywords: api-client,benchmarking,fault-injection,microservices,monitoring,observability,openapi,rcabench,root-cause-analysis
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.9
Requires-Dist: pydantic>=2
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: typing-extensions>=4.7.1
Requires-Dist: urllib3<3.0.0,>=2.1.0
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: flake8>=4.0.0; extra == 'dev'
Requires-Dist: mypy>=1.5; extra == 'dev'
Requires-Dist: pytest-cov>=2.8.1; extra == 'dev'
Requires-Dist: pytest>=7.2.1; extra == 'dev'
Requires-Dist: tox>=3.9.0; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: types-python-dateutil>=2.8.19.14; extra == 'dev'
Description-Content-Type: text/markdown

# rcabench
RCABench - A comprehensive root cause analysis benchmarking platform for microservices
This API provides endpoints for managing datasets, algorithms, evaluations, and fault injections
for root cause analysis in distributed systems and microservices architectures.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.1
- Package version: 1.0.0
- Generator version: 7.14.0-SNAPSHOT
- 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:

```sh
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:
```python
import rcabench_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import rcabench_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import rcabench_client
from rcabench_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = rcabench_client.Configuration(
    host = "http://localhost:8080/api/v1"
)



# Enter a context with an instance of the API client
with rcabench_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rcabench_client.AlgorithmApi(api_client)
    file = None # bytearray | 算法文件 (zip/tar.gz) (optional)
    algo = 'algo_example' # str | 算法名称 (optional)

    try:
        # 构建算法镜像
        api_response = api_instance.api_v1_algorithms_build_post(file=file, algo=algo)
        print("The response of AlgorithmApi->api_v1_algorithms_build_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AlgorithmApi->api_v1_algorithms_build_post: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8080/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AlgorithmApi* | [**api_v1_algorithms_build_post**](docs/AlgorithmApi.md#api_v1_algorithms_build_post) | **POST** /api/v1/algorithms/build | 构建算法镜像
*AlgorithmApi* | [**api_v1_algorithms_get**](docs/AlgorithmApi.md#api_v1_algorithms_get) | **GET** /api/v1/algorithms | 获取算法列表
*AlgorithmApi* | [**api_v1_algorithms_post**](docs/AlgorithmApi.md#api_v1_algorithms_post) | **POST** /api/v1/algorithms | 执行算法
*DatasetApi* | [**api_v1_datasets_delete**](docs/DatasetApi.md#api_v1_datasets_delete) | **DELETE** /api/v1/datasets | 删除数据集数据
*DatasetApi* | [**api_v1_datasets_download_get**](docs/DatasetApi.md#api_v1_datasets_download_get) | **GET** /api/v1/datasets/download | 下载数据集打包文件
*DatasetApi* | [**api_v1_datasets_get**](docs/DatasetApi.md#api_v1_datasets_get) | **GET** /api/v1/datasets | 分页查询数据集列表
*DatasetApi* | [**api_v1_datasets_post**](docs/DatasetApi.md#api_v1_datasets_post) | **POST** /api/v1/datasets | 批量构建数据集
*DatasetApi* | [**api_v1_datasets_query_get**](docs/DatasetApi.md#api_v1_datasets_query_get) | **GET** /api/v1/datasets/query | 查询单个数据集详情
*EvaluationApi* | [**api_v1_evaluations_get**](docs/EvaluationApi.md#api_v1_evaluations_get) | **GET** /api/v1/evaluations | 获取每种算法的执行历史记录
*InjectionApi* | [**api_v1_injections_conf_get**](docs/InjectionApi.md#api_v1_injections_conf_get) | **GET** /api/v1/injections/conf | 获取故障注入配置
*InjectionApi* | [**api_v1_injections_configs_get**](docs/InjectionApi.md#api_v1_injections_configs_get) | **GET** /api/v1/injections/configs | 获取故障注入配置列表
*InjectionApi* | [**api_v1_injections_get**](docs/InjectionApi.md#api_v1_injections_get) | **GET** /api/v1/injections | 分页查询注入记录列表
*InjectionApi* | [**api_v1_injections_ns_status_get**](docs/InjectionApi.md#api_v1_injections_ns_status_get) | **GET** /api/v1/injections/ns/status | 获取命名空间锁状态
*InjectionApi* | [**api_v1_injections_post**](docs/InjectionApi.md#api_v1_injections_post) | **POST** /api/v1/injections | 注入故障
*InjectionApi* | [**api_v1_injections_query_get**](docs/InjectionApi.md#api_v1_injections_query_get) | **GET** /api/v1/injections/query | 查询故障注入记录
*InjectionApi* | [**api_v1_injections_task_id_cancel_put**](docs/InjectionApi.md#api_v1_injections_task_id_cancel_put) | **PUT** /api/v1/injections/{task_id}/cancel | 取消故障注入任务
*TaskApi* | [**api_v1_tasks_list_get**](docs/TaskApi.md#api_v1_tasks_list_get) | **GET** /api/v1/tasks/list | 获取任务列表
*TaskApi* | [**api_v1_tasks_queue_get**](docs/TaskApi.md#api_v1_tasks_queue_get) | **GET** /api/v1/tasks/queue | 获取队列中的任务
*TaskApi* | [**api_v1_tasks_task_id_get**](docs/TaskApi.md#api_v1_tasks_task_id_get) | **GET** /api/v1/tasks/{task_id} | 获取任务详情
*TraceApi* | [**api_v1_traces_analyze_get**](docs/TraceApi.md#api_v1_traces_analyze_get) | **GET** /api/v1/traces/analyze | 分析链路数据
*TraceApi* | [**api_v1_traces_completed_get**](docs/TraceApi.md#api_v1_traces_completed_get) | **GET** /api/v1/traces/completed | 获取完成状态的链路
*TraceApi* | [**api_v1_traces_trace_id_stream_get**](docs/TraceApi.md#api_v1_traces_trace_id_stream_get) | **GET** /api/v1/traces/{trace_id}/stream | 获取跟踪流数据


## Documentation For Models

 - [ConstsTaskType](docs/ConstsTaskType.md)
 - [DtoAlgorithmExecutionPayload](docs/DtoAlgorithmExecutionPayload.md)
 - [DtoAlgorithmListResp](docs/DtoAlgorithmListResp.md)
 - [DtoConclusion](docs/DtoConclusion.md)
 - [DtoDatasetBuildPayload](docs/DtoDatasetBuildPayload.md)
 - [DtoDatasetDeleteResp](docs/DtoDatasetDeleteResp.md)
 - [DtoDatasetItem](docs/DtoDatasetItem.md)
 - [DtoDetectorRecord](docs/DtoDetectorRecord.md)
 - [DtoEvaluationItem](docs/DtoEvaluationItem.md)
 - [DtoEvaluationListResp](docs/DtoEvaluationListResp.md)
 - [DtoExecution](docs/DtoExecution.md)
 - [DtoExecutionRecord](docs/DtoExecutionRecord.md)
 - [DtoGenericResponseAny](docs/DtoGenericResponseAny.md)
 - [DtoGenericResponseDtoAlgorithmListResp](docs/DtoGenericResponseDtoAlgorithmListResp.md)
 - [DtoGenericResponseDtoDatasetDeleteResp](docs/DtoGenericResponseDtoDatasetDeleteResp.md)
 - [DtoGenericResponseDtoEvaluationListResp](docs/DtoGenericResponseDtoEvaluationListResp.md)
 - [DtoGenericResponseDtoPaginationRespDtoDatasetItem](docs/DtoGenericResponseDtoPaginationRespDtoDatasetItem.md)
 - [DtoGenericResponseDtoPaginationRespDtoInjectionItem](docs/DtoGenericResponseDtoPaginationRespDtoInjectionItem.md)
 - [DtoGenericResponseDtoPaginationRespDtoTaskItem](docs/DtoGenericResponseDtoPaginationRespDtoTaskItem.md)
 - [DtoGenericResponseDtoPaginationRespDtoUnifiedTask](docs/DtoGenericResponseDtoPaginationRespDtoUnifiedTask.md)
 - [DtoGenericResponseDtoQueryDatasetResp](docs/DtoGenericResponseDtoQueryDatasetResp.md)
 - [DtoGenericResponseDtoSubmitResp](docs/DtoGenericResponseDtoSubmitResp.md)
 - [DtoGenericResponseDtoTaskDetailResp](docs/DtoGenericResponseDtoTaskDetailResp.md)
 - [DtoGranularityRecord](docs/DtoGranularityRecord.md)
 - [DtoInjectionItem](docs/DtoInjectionItem.md)
 - [DtoInjectionSubmitReq](docs/DtoInjectionSubmitReq.md)
 - [DtoPaginationRespDtoDatasetItem](docs/DtoPaginationRespDtoDatasetItem.md)
 - [DtoPaginationRespDtoInjectionItem](docs/DtoPaginationRespDtoInjectionItem.md)
 - [DtoPaginationRespDtoTaskItem](docs/DtoPaginationRespDtoTaskItem.md)
 - [DtoPaginationRespDtoUnifiedTask](docs/DtoPaginationRespDtoUnifiedTask.md)
 - [DtoQueryDatasetResp](docs/DtoQueryDatasetResp.md)
 - [DtoRetryPolicy](docs/DtoRetryPolicy.md)
 - [DtoSubmitResp](docs/DtoSubmitResp.md)
 - [DtoTaskDetailResp](docs/DtoTaskDetailResp.md)
 - [DtoTaskItem](docs/DtoTaskItem.md)
 - [DtoTrace](docs/DtoTrace.md)
 - [DtoUnifiedTask](docs/DtoUnifiedTask.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author

team@rcabench.com


