cloudreactor-python-api-client
Python client for the CloudReactor API
Overview
This python package allows python applications to programmatically create, monitor, and manage Tasks and Workflows in CloudReactor. Most notably, you can start and stop Tasks and Workflows by creating Task Executions and Workflow Executions.
See the CloudReactor landing page to see the benefits of monitoring and managing your tasks with CloudReactor.
Installation
Get this package from PyPI:
pip install cloudreactor_api_client
Usage
First, create a client:
from cloudreactor_api_client import AuthenticatedClient
client = AuthenticatedClient(base_url="https://api.cloudreactor.io/api/v1",
token="YOUR_API_KEY")
To start a Task, create a Task Execution:
from cloudreactor_api_client.api.task_executions import (
task_executions_create
)
from cloudreactor_api_client.models import (
TaskExecution,
TaskExecutionStatus
)
# Identify the Task by name. Alternatively, you can specifiy the "uuid".
task_dict = {"name": "HappyTask"}
task_execution = TaskExecution.from_dict({
"task": task_dict,
"status": TaskExecutionStatus.MANUALLY_STARTED
})
response = task_executions_create.sync_detailed(client=client,
json_body=task_execution)
parsed_task_execution = response.parsed
print(f"Task Execution {parsed_task_execution.uuid} started!")
More details on how to use API clients in general (async mode, disabling SSL) can be found in the generated README.
License
This software is licensed under the BSD 2-Clause License.
See LICENSE for details.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
Jeff Tsay 💻 📖 🚇 🚧 |
This project follows the all-contributors specification. Contributions of any kind welcome!
Credits
Code generated by openapi-python-client
Metadata
Release files for cloudreactor-api-client 0.3.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cloudreactor-api-client-0.3.1.3.tar.gz | 75.1 kB | Without provenance | Details for cloudreactor-api-client-0.3.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cloudreactor_api_client-0.3.1.3-py3-none-any.whl | Python 3 | none | any | Details for cloudreactor_api_client-0.3.1.3-py3-none-any.whl |
Total release size: 268.5 kB
Release files / cloudreactor-api-client-0.3.1.3.tar.gz
| Download URL | cloudreactor-api-client-0.3.1.3.tar.gz |
|---|---|
| Size | 75.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7e3f1d6e5d552067124b12a5fd42a8918c6ef6fd3f14a750e19dfc121d25f5c7
|
|
BLAKE2b-256 checksum How to use checksums |
51cae4aa6240ebd44894c77513f53e76b994c444a144dc55232aebfbfa5894d9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.4 CPython/3.7.3 Linux/4.19.104-microsoft-standard
|
Release files / cloudreactor_api_client-0.3.1.3-py3-none-any.whl
| Download URL | cloudreactor_api_client-0.3.1.3-py3-none-any.whl |
|---|---|
| Size | 193.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dc624b8277e109f5003991ee154738f5a7d673dc5737ad30cb9d0041d13a66a2
|
|
BLAKE2b-256 checksum How to use checksums |
75c5c7444e30a5ab532c88caae883a109691136e09772d1cf9c35e505c4df883
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.4 CPython/3.7.3 Linux/4.19.104-microsoft-standard
|
Security for cloudreactor-api-client 0.3.1.3
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.