# Wrk Platform SDK
A Python Wrk Platform SDK. It is a library that provides a set of tools to interact with the Wrk Platform.
## Requirements.
Python 3.8+
## Installation & Usage
```sh
pip install wrk-platform-sdk
```
Then import the package:
```python
import wrk_platform_sdk
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import wrk_platform_sdk
from wrk_platform_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://account.wrk.com/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = wrk_platform_sdk.Configuration(
host = "https://account.wrk.com/api/v1"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: ApiKeyAuth
configuration.api_key_prefix['ApiKeyAuth'] = 'Api-Key'
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Enter a context with an instance of the API client
with wrk_platform_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = wrk_platform_sdk.LaunchesApi(api_client)
launch_id = 'launch_id_example' # str |
try:
# Fetch a specific Wrkflow Launch
api_response = api_instance.get_launch_by_id(launch_id)
print("The response of LaunchesApi->get_launch_by_id:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling LaunchesApi->get_launch_by_id: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://account.wrk.com/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LaunchesApi* | [**get_launch_by_id**](docs/LaunchesApi.md#get_launch_by_id) | **GET** /launch/{launch_id} | Fetch a specific Wrkflow Launch
*LaunchesApi* | [**get_launches**](docs/LaunchesApi.md#get_launches) | **GET** /launch | Fetch multiple Wrkflow Launches
*LaunchesApi* | [**launch_wrkflow**](docs/LaunchesApi.md#launch_wrkflow) | **POST** /wrkflow/{wrkflow_uuid}/launch | Launch a Wrkflow
*LaunchesApi* | [**pause_launch**](docs/LaunchesApi.md#pause_launch) | **POST** /launch/{launch_id}/pause | Pause a Wrkflow Launch
*LaunchesApi* | [**resume_launch**](docs/LaunchesApi.md#resume_launch) | **POST** /launch/{launch_id}/resume | Resume a Wrkflow Launch
*WrkflowsApi* | [**get_wrkflow_by_uuid**](docs/WrkflowsApi.md#get_wrkflow_by_uuid) | **GET** /wrkflow/{wrkflow_uuid} | Fetch a specific Wrkflow
*WrkflowsApi* | [**get_wrkflows**](docs/WrkflowsApi.md#get_wrkflows) | **GET** /wrkflow | Fetch multiple Wrkflows
## Documentation For Models
- [GetLaunchByIdResponse](docs/GetLaunchByIdResponse.md)
- [GetLaunchesResponse](docs/GetLaunchesResponse.md)
- [GetWrkflowByUuidResponse](docs/GetWrkflowByUuidResponse.md)
- [GetWrkflowsResponse](docs/GetWrkflowsResponse.md)
- [Launch](docs/Launch.md)
- [LaunchState](docs/LaunchState.md)
- [LaunchWrkflowRequest](docs/LaunchWrkflowRequest.md)
- [LaunchWrkflowResponse](docs/LaunchWrkflowResponse.md)
- [WrkError](docs/WrkError.md)
- [WrkErrorDetails](docs/WrkErrorDetails.md)
- [Wrkflow](docs/Wrkflow.md)
- [WrkflowSchedule](docs/WrkflowSchedule.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth
- **Type**: API key
- **API key parameter name**: Authorization
- **API key prefix**: Api-Key
- **Location**: HTTP header
Raw data
{
"_id": null,
"home_page": null,
"name": "wrk-platform-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Wrk",
"author": "Wrk Technologies",
"author_email": "support@wrk.com",
"download_url": "https://files.pythonhosted.org/packages/d5/f8/6ba9a91a37f9b718e4067fd17227abe8cd1639409b92a0a5e0513b87f765/wrk_platform_sdk-2.0.0.tar.gz",
"platform": null,
"description": "# Wrk Platform SDK\n\nA Python Wrk Platform SDK. It is a library that provides a set of tools to interact with the Wrk Platform.\n\n## Requirements.\n\nPython 3.8+\n\n## Installation & Usage\n\n```sh\npip install wrk-platform-sdk\n```\n\nThen import the package:\n```python\nimport wrk_platform_sdk\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport wrk_platform_sdk\nfrom wrk_platform_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://account.wrk.com/api/v1\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = wrk_platform_sdk.Configuration(\n host = \"https://account.wrk.com/api/v1\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure API key authorization: ApiKeyAuth\nconfiguration.api_key_prefix['ApiKeyAuth'] = 'Api-Key'\nconfiguration.api_key['ApiKeyAuth'] = os.environ[\"API_KEY\"]\n\n# Enter a context with an instance of the API client\nwith wrk_platform_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = wrk_platform_sdk.LaunchesApi(api_client)\n launch_id = 'launch_id_example' # str |\n\n try:\n # Fetch a specific Wrkflow Launch\n api_response = api_instance.get_launch_by_id(launch_id)\n print(\"The response of LaunchesApi->get_launch_by_id:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling LaunchesApi->get_launch_by_id: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://account.wrk.com/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*LaunchesApi* | [**get_launch_by_id**](docs/LaunchesApi.md#get_launch_by_id) | **GET** /launch/{launch_id} | Fetch a specific Wrkflow Launch\n*LaunchesApi* | [**get_launches**](docs/LaunchesApi.md#get_launches) | **GET** /launch | Fetch multiple Wrkflow Launches\n*LaunchesApi* | [**launch_wrkflow**](docs/LaunchesApi.md#launch_wrkflow) | **POST** /wrkflow/{wrkflow_uuid}/launch | Launch a Wrkflow\n*LaunchesApi* | [**pause_launch**](docs/LaunchesApi.md#pause_launch) | **POST** /launch/{launch_id}/pause | Pause a Wrkflow Launch\n*LaunchesApi* | [**resume_launch**](docs/LaunchesApi.md#resume_launch) | **POST** /launch/{launch_id}/resume | Resume a Wrkflow Launch\n*WrkflowsApi* | [**get_wrkflow_by_uuid**](docs/WrkflowsApi.md#get_wrkflow_by_uuid) | **GET** /wrkflow/{wrkflow_uuid} | Fetch a specific Wrkflow\n*WrkflowsApi* | [**get_wrkflows**](docs/WrkflowsApi.md#get_wrkflows) | **GET** /wrkflow | Fetch multiple Wrkflows\n\n\n## Documentation For Models\n\n - [GetLaunchByIdResponse](docs/GetLaunchByIdResponse.md)\n - [GetLaunchesResponse](docs/GetLaunchesResponse.md)\n - [GetWrkflowByUuidResponse](docs/GetWrkflowByUuidResponse.md)\n - [GetWrkflowsResponse](docs/GetWrkflowsResponse.md)\n - [Launch](docs/Launch.md)\n - [LaunchState](docs/LaunchState.md)\n - [LaunchWrkflowRequest](docs/LaunchWrkflowRequest.md)\n - [LaunchWrkflowResponse](docs/LaunchWrkflowResponse.md)\n - [WrkError](docs/WrkError.md)\n - [WrkErrorDetails](docs/WrkErrorDetails.md)\n - [Wrkflow](docs/Wrkflow.md)\n - [WrkflowSchedule](docs/WrkflowSchedule.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"ApiKeyAuth\"></a>\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **API key prefix**: Api-Key\n- **Location**: HTTP header\n",
"bugtrack_url": null,
"license": null,
"summary": "Wrk Platform SDK",
"version": "2.0.0",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" wrk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8747e4fd9d8e8dc686ad2ce237a1c24a5efacfc3b622a3805430f2aed5e5d09",
"md5": "4b325a432dee85df3042f7cd661472fd",
"sha256": "0015b996928956581629f6907c4a38b853e3cb9d2a9578e3797ec7b8c78a3b2a"
},
"downloads": -1,
"filename": "wrk_platform_sdk-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4b325a432dee85df3042f7cd661472fd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 48700,
"upload_time": "2025-01-02T16:37:29",
"upload_time_iso_8601": "2025-01-02T16:37:29.859438Z",
"url": "https://files.pythonhosted.org/packages/f8/74/7e4fd9d8e8dc686ad2ce237a1c24a5efacfc3b622a3805430f2aed5e5d09/wrk_platform_sdk-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d5f86ba9a91a37f9b718e4067fd17227abe8cd1639409b92a0a5e0513b87f765",
"md5": "739f3faf9a029e6863de5cde58218cec",
"sha256": "097d7f360b1729e4cd715a23ed68d612e22e8b671dc6d928078edc612749390c"
},
"downloads": -1,
"filename": "wrk_platform_sdk-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "739f3faf9a029e6863de5cde58218cec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30822,
"upload_time": "2025-01-02T16:37:32",
"upload_time_iso_8601": "2025-01-02T16:37:32.005552Z",
"url": "https://files.pythonhosted.org/packages/d5/f8/6ba9a91a37f9b718e4067fd17227abe8cd1639409b92a0a5e0513b87f765/wrk_platform_sdk-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-02 16:37:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "wrk-platform-sdk"
}
JSON