operaton-external-task-client-python3 1.0.0__tar.gz

operaton_external_task_client_python3-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

operaton_external_task_client_python3-1.0.0/PKG-INFO

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: operaton_external_task_client_python3
+Version: 1.0.0
+Summary: External Task Client for Operaton BPM engine. Its based on the camunda-external-task-client-python3 and has been adapted to Operaton.
+Author-email: Deserve Labs <devteam@deserve.com>
+Maintainer: DLR terrabyte team
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/DLR-terrabyte/operaton-external-task-client-python3
+Project-URL: Issues, https://github.com/DLR-terrabyte/operaton-external-task-client-python3/issues
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.24.0
+Dynamic: license-file
+
+> External Task Client for Operaton BPM engine. 
+> Its based on the [camunda-external-task-client-python3](https://github.com/camunda-community-hub/camunda-external-task-client-python3) and has been adapted to Operaton.
+
+# operaton-external-task-client-python3
+
+This repository contains Operaton External Task Client written in Python3.
+
+
+Implement your [BPMN Service Task](https://docs.operaton.org/docs/documentation/user-guide/process-engine/external-tasks) in Python3.
+
+> Python >= 3.7 is required
+
+## Installing
+Add following line to `requirements.txt` of your Python project.
+```
+git+https://github.com/trustfactors/operaton-external-task-client-python3.git/#egg=operaton-external-task-client-python3
+```
+
+Or use pip to install as shown below:
+```
+pip install operaton-external-task-client-python3
+```
+
+## Running Operaton with Docker
+To run the examples provided in [examples](./examples) folder, you need to have Operaton running locally or somewhere.
+
+To run Operaton locally with Postgres DB as backend, you can use [docker-compose.yml](./docker-compose.yml) file.
+
+```
+$> docker-compose -f docker-compose.yml up
+```
+### Auth Basic Examples
+
+> [!WARNING]  
+> This section needs to be refactored into a working example with Operaton.
+
+To run the examples with Auth Basic provided in [examples/examples_auth_basic](./examples/examples_auth_basic) folder, you need to have Operaton with AuthBasic, running locally or somewhere.
+
+To run Operaton with AuthBasic locally with Postgres DB as backend, you can use [docker-compose-auth.yml](./docker-compose-auth.yml) file.
+
+```
+$> docker-compose -f docker-compose-auth.yml up
+```
+
+## Usage
+
+1.  Make sure to have [Operaton](https://github.com/operaton/operaton/releases) running.
+2.  Create a simple process model with an External Service Task and define the topic as 'topicName'.
+3.  Deploy the process to the Operaton BPM engine.
+4.  In your Python code:
+
+```python
+import time
+from operaton.external_task.external_task import ExternalTask, TaskResult
+from operaton.external_task.external_task_worker import ExternalTaskWorker
+
+# configuration for the Client
+default_config = {
+    "maxTasks": 1,
+    "lockDuration": 10000,
+    "asyncResponseTimeout": 5000,
+    "retries": 3,
+    "retryTimeout": 5000,
+    "sleepSeconds": 30
+}
+
+def handle_task(task: ExternalTask) -> TaskResult:
+    """
+    This task handler you need to implement with your business logic.
+    After completion of business logic call either task.complete() or task.failure() or task.bpmn_error() 
+    to report status of task to Operaton
+    """
+    # add your business logic here
+    # ...
+    
+    # mark task either complete/failure/bpmnError based on outcome of your business logic
+    failure, bpmn_error = random_true(), random_true() # this code simulate random failure
+    if failure:
+        # this marks task as failed in Operaton
+        return task.failure(error_message="task failed",  error_details="failed task details", 
+                            max_retries=3, retry_timeout=5000)
+    elif bpmn_error:
+        return task.bpmn_error(error_code="BPMN_ERROR_CODE", error_message="BPMN Error occurred", 
+                                variables={"var1": "value1", "success": False})
+    
+    # pass any output variables you may want to send to Operaton as dictionary to complete()
+    return task.complete({"var1": 1, "var2": "value"}) 
+
+def random_true():
+    current_milli_time = int(round(time.time() * 1000))
+    return current_milli_time % 2 == 0
+
+if __name__ == '__main__':
+   ExternalTaskWorker(worker_id="1", config=default_config).subscribe("topicName", handle_task)
+```
+
+## About External Tasks
+
+External Tasks are service tasks whose execution differs particularly from the execution of other service tasks (e.g. Human Tasks).
+The execution works in a way that units of work are polled from the engine before being completed.
+
+**operaton-external-task-client-python** allows you to create easily such client in Python3.
+
+## Features
+
+### Start process
+Operaton provides functionality to start a process instance for a given process definition.
+
+To start a process instance, we can use `start_process()` from [engine_client.py](./operaton/client/engine_client.py#L24)
+
+You can find a usage example [here](./examples/start_process.py).
+
+```python
+client = EngineClient()
+resp_json = client.start_process(process_key="PARALLEL_STEPS_EXAMPLE", variables={"intVar": "1", "strVar": "hello"},
+                                 tenant_id="6172cdf0-7b32-4460-9da0-ded5107aa977", business_key=str(uuid.uuid1()))
+```
+
+### Fetch and Lock
+
+`ExternalTaskWorker(worker_id="1").subscribe("topicName", handle_task)` starts long polling of the Operaton engine for external tasks.
+
+* Polling tasks from the engine works by performing a fetch & lock operation of tasks that have subscriptions. It then calls the handler function passed to `subscribe()` function. i.e. `handle_task` in above example.
+* Long Polling is done periodically based on the `asyncResponseTimeout` configuration. Read more about [Long Polling](https://docs.operaton.org/docs/documentation/user-guide/process-engine/external-tasks#long-polling-to-fetch-and-lock-external-tasks).
+
+### Complete
+```python
+from operaton.external_task.external_task import ExternalTask, TaskResult
+from operaton.external_task.external_task_worker import ExternalTaskWorker
+def handle_task(task: ExternalTask) -> TaskResult:
+    # add your business logic here
+    
+    # Complete the task
+    # pass any output variables you may want to send to Operaton as dictionary to complete()
+    return task.complete({"var1": 1, "var2": "value"})
+
+ExternalTaskWorker(worker_id="1").subscribe("topicName", handle_task)
+```
+
+### Handle Failure
+```python
+from operaton.external_task.external_task import ExternalTask, TaskResult
+from operaton.external_task.external_task_worker import ExternalTaskWorker
+def handle_task(task: ExternalTask) -> TaskResult:
+    # add your business logic here
+    
+    # Handle task Failure
+    return task.failure(error_message="task failed",  error_details="failed task details", 
+                        max_retries=3, retry_timeout=5000)
+    # This client/worker uses max_retries if no retries are previously set in the task
+    # if retries are previously set then it just decrements that count by one before reporting failure to Operaton
+    # when retries are zero, Operaton creates an incident which then manually needs to be looked into on Operaton Cockpit            
+
+ExternalTaskWorker(worker_id="1").subscribe("topicName", handle_task)
+```
+
+### Handle BPMN Error
+```python
+from operaton.external_task.external_task import ExternalTask, TaskResult
+from operaton.external_task.external_task_worker import ExternalTaskWorker
+def handle_task(task: ExternalTask) -> TaskResult:
+    # add your business logic here
+    
+    # Handle a BPMN Failure
+    return task.bpmn_error(error_code="BPMN_ERROR", error_message="BPMN error occurred")
+
+ExternalTaskWorker(worker_id="1" ).subscribe("topicName", handle_task)
+```
+
+### Access Process Variables
+```python
+from operaton.external_task.external_task import ExternalTask, TaskResult
+from operaton.external_task.external_task_worker import ExternalTaskWorker
+def handle_task(task: ExternalTask) -> TaskResult:
+    # add your business logic here
+    # get the process variable 'score'
+    score = task.get_variable("score")
+    if int(score) >= 100:
+        return task.complete(...)
+    else:
+        return task.failure(...)        
+
+ExternalTaskWorker().subscribe("topicName", handle_task)
+```
+
+### [Correlate message](https://docs.operaton.org/docs/documentation/reference/bpmn20/events/message-events/)
+Operaton provides functionality to send a message event to a running process instance.
+
+You can read more about the message events here: https://docs.operaton.org/docs/documentation/reference/bpmn20/events/message-events/
+
+In our to send a message event to a process instance, a new function called `correlate_message()` is added to [engine_client.py](./operaton/client/engine_client.py#L60)
+
+We can correlate the message by:
+- process_instance_id
+- tenant_id
+- business_key
+- process_variables
+
+You can find a usage example [here](./examples/correlate_message.py).
+
+```python
+client = EngineClient()
+resp_json = client.correlate_message("CANCEL_MESSAGE", business_key="b4a6f392-12ab-11eb-80ef-acde48001122")
+```
+## AuthBasic Usage
+
+To create an EngineClient with AuthBasic simple
+
+```python
+client = EngineClient(config={"auth_basic": {"username": "demo", "password": "demo"}})
+resp_json = client.start_process(process_key="PARALLEL_STEPS_EXAMPLE", variables={"intVar": "1", "strVar": "hello"},
+                                 tenant_id="6172cdf0-7b32-4460-9da0-ded5107aa977", business_key=str(uuid.uuid1()))
+```
+
+To create an ExternalTaskWorker with AuthBasic simple
+
+```python
+from operaton.external_task.external_task import ExternalTask, TaskResult
+from operaton.external_task.external_task_worker import ExternalTaskWorker
+
+config = {"auth_basic": {"username": "demo", "password": "demo"}}
+
+def handle_task(task: ExternalTask) -> TaskResult:
+    # add your business logic here
+    
+    # Complete the task
+    # pass any output variables you may want to send to Operaton as dictionary to complete()
+    return task.complete({"var1": 1, "var2": "value"})
+
+ExternalTaskWorker(worker_id="1", config=config).subscribe("topicName", handle_task)
+```
+
+## License
+The source files in this repository are made available under the [Apache License Version 2.0](./LICENSE).