# Neops Task Engine Client
Neops workflow engine API documentation
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0
- Package version: 0.41.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## 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 neops_workflow_engine_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 neops_workflow_engine_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import neops_workflow_engine_client
from neops_workflow_engine_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = neops_workflow_engine_client.Configuration(
host = "http://localhost"
)
# Enter a context with an instance of the API client
with neops_workflow_engine_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = neops_workflow_engine_client.BlackboardApi(api_client)
request_body = ['request_body_example'] # List[str] |
try:
api_response = api_instance.blackboard_controller_poll_job(request_body)
print("The response of BlackboardApi->blackboard_controller_poll_job:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling BlackboardApi->blackboard_controller_poll_job: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BlackboardApi* | [**blackboard_controller_poll_job**](docs/BlackboardApi.md#blackboard_controller_poll_job) | **POST** /blackboard/job |
*BlackboardApi* | [**blackboard_controller_push_job_result**](docs/BlackboardApi.md#blackboard_controller_push_job_result) | **POST** /blackboard/job/result |
*CmsClientApi* | [**cms_client_controller_get_all_devices**](docs/CmsClientApi.md#cms_client_controller_get_all_devices) | **GET** /cms-client/all-devices |
*CmsClientApi* | [**cms_client_controller_get_random_device**](docs/CmsClientApi.md#cms_client_controller_get_random_device) | **GET** /cms-client/random-device |
*CmsClientApi* | [**cms_client_controller_login**](docs/CmsClientApi.md#cms_client_controller_login) | **POST** /cms-client/login |
*DefaultApi* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / |
*FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks/list | List all registered function blocks
*FunctionBlockApi* | [**function_blocks_controller_find_one**](docs/FunctionBlockApi.md#function_blocks_controller_find_one) | **GET** /function-blocks/{id} | Get a function block by id
*FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks/register | Register a function block
*FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} | Unregister a function block
*HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | Check health of task engine
*WorkflowsApi* | [**workflow_controller_execute**](docs/WorkflowsApi.md#workflow_controller_execute) | **POST** /workflow | Execute a workflow
*WorkflowsApi* | [**workflow_controller_ge_all**](docs/WorkflowsApi.md#workflow_controller_ge_all) | **GET** /workflow/failed | List all failed workflows
*WorkflowsApi* | [**workflow_controller_get_all**](docs/WorkflowsApi.md#workflow_controller_get_all) | **GET** /workflow/all | List all workflows
*WorkflowsApi* | [**workflow_controller_get_running**](docs/WorkflowsApi.md#workflow_controller_get_running) | **GET** /workflow/running | List all running workflows
*WorkflowsApi* | [**workflow_controller_remove**](docs/WorkflowsApi.md#workflow_controller_remove) | **DELETE** /workflow/{id} | Stop a workflow
## Documentation For Models
- [DeviceDto](docs/DeviceDto.md)
- [DevicesResponseDto](docs/DevicesResponseDto.md)
- [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)
- [HealthResponse](docs/HealthResponse.md)
- [JobDefinitionDto](docs/JobDefinitionDto.md)
- [JobResultDto](docs/JobResultDto.md)
- [LoginResponseDto](docs/LoginResponseDto.md)
- [ParametrizedFunctionBlockDto](docs/ParametrizedFunctionBlockDto.md)
- [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)
- [WorkflowDto](docs/WorkflowDto.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="JWT"></a>
### JWT
- **Type**: Bearer authentication (JWT)
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "neops_workflow_engine_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Neops Workflow Engine",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/1a/eb/2b170d0d6721b11a58b442a0305fbbe2ebd6156ba22ff8905e63943a9e27/neops_workflow_engine_client-0.41.0.tar.gz",
"platform": null,
"description": "# Neops Task Engine Client\nNeops workflow engine API documentation\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0\n- Package version: 0.41.0\n- Generator version: 7.9.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport neops_workflow_engine_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport neops_workflow_engine_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport neops_workflow_engine_client\nfrom neops_workflow_engine_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = neops_workflow_engine_client.Configuration(\n host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith neops_workflow_engine_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = neops_workflow_engine_client.BlackboardApi(api_client)\n request_body = ['request_body_example'] # List[str] | \n\n try:\n api_response = api_instance.blackboard_controller_poll_job(request_body)\n print(\"The response of BlackboardApi->blackboard_controller_poll_job:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling BlackboardApi->blackboard_controller_poll_job: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*BlackboardApi* | [**blackboard_controller_poll_job**](docs/BlackboardApi.md#blackboard_controller_poll_job) | **POST** /blackboard/job | \n*BlackboardApi* | [**blackboard_controller_push_job_result**](docs/BlackboardApi.md#blackboard_controller_push_job_result) | **POST** /blackboard/job/result | \n*CmsClientApi* | [**cms_client_controller_get_all_devices**](docs/CmsClientApi.md#cms_client_controller_get_all_devices) | **GET** /cms-client/all-devices | \n*CmsClientApi* | [**cms_client_controller_get_random_device**](docs/CmsClientApi.md#cms_client_controller_get_random_device) | **GET** /cms-client/random-device | \n*CmsClientApi* | [**cms_client_controller_login**](docs/CmsClientApi.md#cms_client_controller_login) | **POST** /cms-client/login | \n*DefaultApi* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / | \n*FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks/list | List all registered function blocks\n*FunctionBlockApi* | [**function_blocks_controller_find_one**](docs/FunctionBlockApi.md#function_blocks_controller_find_one) | **GET** /function-blocks/{id} | Get a function block by id\n*FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks/register | Register a function block\n*FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} | Unregister a function block\n*HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | Check health of task engine\n*WorkflowsApi* | [**workflow_controller_execute**](docs/WorkflowsApi.md#workflow_controller_execute) | **POST** /workflow | Execute a workflow\n*WorkflowsApi* | [**workflow_controller_ge_all**](docs/WorkflowsApi.md#workflow_controller_ge_all) | **GET** /workflow/failed | List all failed workflows\n*WorkflowsApi* | [**workflow_controller_get_all**](docs/WorkflowsApi.md#workflow_controller_get_all) | **GET** /workflow/all | List all workflows\n*WorkflowsApi* | [**workflow_controller_get_running**](docs/WorkflowsApi.md#workflow_controller_get_running) | **GET** /workflow/running | List all running workflows\n*WorkflowsApi* | [**workflow_controller_remove**](docs/WorkflowsApi.md#workflow_controller_remove) | **DELETE** /workflow/{id} | Stop a workflow\n\n\n## Documentation For Models\n\n - [DeviceDto](docs/DeviceDto.md)\n - [DevicesResponseDto](docs/DevicesResponseDto.md)\n - [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)\n - [HealthResponse](docs/HealthResponse.md)\n - [JobDefinitionDto](docs/JobDefinitionDto.md)\n - [JobResultDto](docs/JobResultDto.md)\n - [LoginResponseDto](docs/LoginResponseDto.md)\n - [ParametrizedFunctionBlockDto](docs/ParametrizedFunctionBlockDto.md)\n - [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)\n - [WorkflowDto](docs/WorkflowDto.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=\"JWT\"></a>\n### JWT\n\n- **Type**: Bearer authentication (JWT)\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Neops Workflow Engine",
"version": "0.41.0",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" neops workflow engine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "743ec7be551741cfe394d8cb55efb5af1be5c15fb4c7c0ad0fe1e4ec30d4a79c",
"md5": "37fb6438bc867ee5c10b6c157138f93a",
"sha256": "24bbbe2e976e2c03df3256113acf39e3021508e1838ce2e44156ddde51a5ac7d"
},
"downloads": -1,
"filename": "neops_workflow_engine_client-0.41.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37fb6438bc867ee5c10b6c157138f93a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 47205,
"upload_time": "2024-11-12T14:13:38",
"upload_time_iso_8601": "2024-11-12T14:13:38.659652Z",
"url": "https://files.pythonhosted.org/packages/74/3e/c7be551741cfe394d8cb55efb5af1be5c15fb4c7c0ad0fe1e4ec30d4a79c/neops_workflow_engine_client-0.41.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1aeb2b170d0d6721b11a58b442a0305fbbe2ebd6156ba22ff8905e63943a9e27",
"md5": "102badab34d3f470b6fa01ae7e17fd5a",
"sha256": "b8de66353dff405f6e7b0e9be6d5717112e141c7eaaa8b8122959ce07601677a"
},
"downloads": -1,
"filename": "neops_workflow_engine_client-0.41.0.tar.gz",
"has_sig": false,
"md5_digest": "102badab34d3f470b6fa01ae7e17fd5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 26197,
"upload_time": "2024-11-12T14:13:39",
"upload_time_iso_8601": "2024-11-12T14:13:39.813908Z",
"url": "https://files.pythonhosted.org/packages/1a/eb/2b170d0d6721b11a58b442a0305fbbe2ebd6156ba22ff8905e63943a9e27/neops_workflow_engine_client-0.41.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 14:13:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "neops_workflow_engine_client"
}
JSON
