move external-worker to sub-directory

flowable · Sep 20, 2024 · 07f25ec · 07f25ec
1 parent a1f2813
commit 07f25ec
Show file tree

Hide file tree

Showing 45 changed files with 81 additions and 66 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -20,6 +20,7 @@ jobs:
       - run: pip install virtualenv
       - run: virtualenv venv
       - run: source venv/bin/activate
+      - run: cd external-worker/
       - run: pip install setuptools
       - run: pip install -e ".[testing]"
       - run: python -m unittest discover
@@ -40,7 +41,7 @@ jobs:
       - run: pip install virtualenv
       - run: virtualenv venv
       - run: source venv/bin/activate
-      - run: python setup.py install
+      - run: python external-worker/setup.py install
       - run: cd robocorp/
       - run: pip install setuptools
       - run: pip install -e ".[testing]"

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,10 +21,11 @@ jobs:
       - run: virtualenv venv
       - run: source venv/bin/activate
       - run: pip install setuptools
+      - run: cd external-worker/
       - run: python setup.py sdist
       - run: pip wheel --no-deps . -w dist
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          packages-dir: dist/
+          packages-dir: external-worker/dist/
           verbose: true
diff --git a/.github/workflows/test-release.yml b/.github/workflows/test-release.yml
@@ -23,11 +23,12 @@ jobs:
       - run: virtualenv venv
       - run: source venv/bin/activate
       - run: pip install setuptools
+      - run: cd external-worker/
       - run: python setup.py sdist
       - run: pip wheel --no-deps . -w dist
       - name: Publish package distributions to Test PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           repository-url: https://test.pypi.org/legacy/
-          packages-dir: dist/
+          packages-dir: external-worker/dist/
           verbose: true
diff --git a/README.md b/README.md
@@ -1,67 +1,12 @@
-# Flowable External Worker Library for Python
+# Flowable External Client Python
 
 [License:
 ![license](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/flowable/flowable-external-client-python/blob/main/LICENSE)
 
 ![Flowable Actions CI](https://github.com/flowable/flowable-external-client-python/actions/workflows/main.yml/badge.svg?branch=main)
 
-An _External Worker Task_ in BPMN or CMMN is a task where the custom logic of that task is executed externally to Flowable, i.e. on another server.
-When the process or case engine arrives at such a task, it will create an **external job**, which is exposed over the REST API.
-Through this REST API, the job can be acquired and locked.
-Once locked, the custom logic is responsible for signalling over REST that the work is done and the process or case can continue.
-
-This project makes implementing such custom logic in Python easy by not having the worry about the low-level details of the REST API and focus on the actual custom business logic.
-Integrations for other languages are available, too.
-
-## Authentication
-
-The different ways to authenticate are explained in the [documentation of the underlying requests HTTP library which is used to connect to Flowable](https://requests.readthedocs.io/en/latest/user/authentication/).
-The `ExternalWorkerClient` accepts as a parameter `auth` an implementation of `requests.auth.AuthBase`.
-There are default implementations for example for basic authentication e.g. `HTTPBasicAuth("admin", "test")`.
-Flowable offers a bearer token implementation `FlowableCloudToken` which allows to specify an access token to the Flowable Cloud offering.
-
-## Installation
-
-To install the external worker library, execute the following command:
-
-```
-pip install flowable.external-worker-client
-```
-
-## Sample
-
-### Cloud
-
-The usage with Flowable Cloud is simpler, since everything is pre-configured.
-However, it's required to either use the user credentials or to pre-configure a personal access token.
-
-```python
-from flowable.external_worker_client import ExternalWorkerClient
-from flowable.external_worker_client.cloud_token import FlowableCloudToken
-
-client = ExternalWorkerClient(auth=FlowableCloudToken("<personal-access-token>"))
-
-def my_callback(job, worker_result_builder):
-    print('Executed job: ' + job.id)
-    return worker_result_builder.success()
-
-subscription = client.subscribe('myTopic', my_callback)
-```
-
-### Local
-
-The following is an example how you can connect to a Flowable instance running at `http://localhost:8090` and process all messages retrieved on the topic `myTopic`:
-
-```python
-from flowable.external_worker_client import ExternalWorkerClient
-from requests.auth import HTTPBasicAuth
-
-client = ExternalWorkerClient('http://localhost:8090/flowable-work', auth=HTTPBasicAuth("admin", "test"))
-
-def my_callback(job, worker_result_builder):
-    print('Executed job: ' + job.id)
-    return worker_result_builder.success()
-
-subscription = client.subscribe('myTopic', my_callback)
-```
+This is a collection of multiple Flowable Python clients.
+Currently, the project consists out of:
 
+* [External Worker Client](./external-worker): A library to connect custom application code to Flowable with the external worker functionality
+* [Robocorp Client](./robocorp-client): A python module to execute Robocorp actions and tasks with the Flowable Robocorp task (based on the external worker).
diff --git a/external-worker/README.md b/external-worker/README.md
@@ -0,0 +1,67 @@
+# Flowable External Worker Library for Python
+
+
+[License:
+![license](https://img.shields.io/hexpm/l/plug.svg)](https://github.com/flowable/flowable-external-client-python/blob/main/LICENSE)
+
+![Flowable Actions CI](https://github.com/flowable/flowable-external-client-python/actions/workflows/main.yml/badge.svg?branch=main)
+
+An _External Worker Task_ in BPMN or CMMN is a task where the custom logic of that task is executed externally to Flowable, i.e. on another server.
+When the process or case engine arrives at such a task, it will create an **external job**, which is exposed over the REST API.
+Through this REST API, the job can be acquired and locked.
+Once locked, the custom logic is responsible for signalling over REST that the work is done and the process or case can continue.
+
+This project makes implementing such custom logic in Python easy by not having the worry about the low-level details of the REST API and focus on the actual custom business logic.
+Integrations for other languages are available, too.
+
+## Authentication
+
+The different ways to authenticate are explained in the [documentation of the underlying requests HTTP library which is used to connect to Flowable](https://requests.readthedocs.io/en/latest/user/authentication/).
+The `ExternalWorkerClient` accepts as a parameter `auth` an implementation of `requests.auth.AuthBase`.
+There are default implementations for example for basic authentication e.g. `HTTPBasicAuth("admin", "test")`.
+Flowable offers a bearer token implementation `FlowableCloudToken` which allows to specify an access token to the Flowable Cloud offering.
+
+## Installation
+
+To install the external worker library, execute the following command:
+
+```
+pip install flowable.external-worker-client
+```
+
+## Sample
+
+### Cloud
+
+The usage with Flowable Cloud is simpler, since everything is pre-configured.
+However, it's required to either use the user credentials or to pre-configure a personal access token.
+
+```python
+from flowable.external_worker_client import ExternalWorkerClient
+from flowable.external_worker_client.cloud_token import FlowableCloudToken
+
+client = ExternalWorkerClient(auth=FlowableCloudToken("<personal-access-token>"))
+
+def my_callback(job, worker_result_builder):
+    print('Executed job: ' + job.id)
+    return worker_result_builder.success()
+
+subscription = client.subscribe('myTopic', my_callback)
+```
+
+### Local
+
+The following is an example how you can connect to a Flowable instance running at `http://localhost:8090` and process all messages retrieved on the topic `myTopic`:
+
+```python
+from flowable.external_worker_client import ExternalWorkerClient
+from requests.auth import HTTPBasicAuth
+
+client = ExternalWorkerClient('http://localhost:8090/flowable-work', auth=HTTPBasicAuth("admin", "test"))
+
+def my_callback(job, worker_result_builder):
+    print('Executed job: ' + job.id)
+    return worker_result_builder.success()
+
+subscription = client.subscribe('myTopic', my_callback)
+```
diff --git a/flowable/__init__.py → external-worker/flowable/__init__.py b/flowable/__init__.py → external-worker/flowable/__init__.py
diff --git a/flowable/external_worker_client/__init__.py → ...owable/external_worker_client/__init__.py b/flowable/external_worker_client/__init__.py → ...owable/external_worker_client/__init__.py
diff --git a/...ble/external_worker_client/cloud_token.py → ...ble/external_worker_client/cloud_token.py b/...ble/external_worker_client/cloud_token.py → ...ble/external_worker_client/cloud_token.py
diff --git a/...nal_worker_client/engine_rest_variable.py → ...nal_worker_client/engine_rest_variable.py b/...nal_worker_client/engine_rest_variable.py → ...nal_worker_client/engine_rest_variable.py
diff --git a/...t/external_worker_acquire_job_response.py → ...t/external_worker_acquire_job_response.py b/...t/external_worker_acquire_job_response.py → ...t/external_worker_acquire_job_response.py
diff --git a/...er_client/external_worker_job_response.py → ...er_client/external_worker_job_response.py b/...er_client/external_worker_job_response.py → ...er_client/external_worker_job_response.py
diff --git a/..._worker_client/flowable_rest_exception.py → ..._worker_client/flowable_rest_exception.py b/..._worker_client/flowable_rest_exception.py → ..._worker_client/flowable_rest_exception.py
diff --git a/...ble/external_worker_client/list_result.py → ...ble/external_worker_client/list_result.py b/...ble/external_worker_client/list_result.py → ...ble/external_worker_client/list_result.py
diff --git a/...ternal_worker_client/request_converter.py → ...ternal_worker_client/request_converter.py b/...ternal_worker_client/request_converter.py → ...ternal_worker_client/request_converter.py
diff --git a/...ernal_worker_client/response_converter.py → ...ernal_worker_client/response_converter.py b/...ernal_worker_client/response_converter.py → ...ernal_worker_client/response_converter.py
diff --git a/...able/external_worker_client/restclient.py → ...able/external_worker_client/restclient.py b/...able/external_worker_client/restclient.py → ...able/external_worker_client/restclient.py
diff --git a/flowable/external_worker_client/utils.py → .../flowable/external_worker_client/utils.py b/flowable/external_worker_client/utils.py → .../flowable/external_worker_client/utils.py
diff --git a/...e/external_worker_client/worker_result.py → ...e/external_worker_client/worker_result.py b/...e/external_worker_client/worker_result.py → ...e/external_worker_client/worker_result.py
diff --git a/setup.py → external-worker/setup.py b/setup.py → external-worker/setup.py
@@ -9,7 +9,7 @@
 setup(
     name='flowable.external-worker-client',
     packages=['flowable', 'flowable.external_worker_client'],
-    version='1.1.0rc1',
+    version='1.0.1rc1',
     description='Flowable External Worker Library to connect Python code to Flowable using an external worker.',
     long_description=long_description,
     long_description_content_type='text/markdown',

diff --git a/tests/__init__.py → external-worker/tests/__init__.py b/tests/__init__.py → external-worker/tests/__init__.py
diff --git a/tests/basic_test.py → external-worker/tests/basic_test.py b/tests/basic_test.py → external-worker/tests/basic_test.py
diff --git a/tests/bpmn_utils.py → external-worker/tests/bpmn_utils.py b/tests/bpmn_utils.py → external-worker/tests/bpmn_utils.py
diff --git a/tests/cmmn_utils.py → external-worker/tests/cmmn_utils.py b/tests/cmmn_utils.py → external-worker/tests/cmmn_utils.py
diff --git a/tests/fixtures/cases/externalWorkerCase.cmmn → ...ts/fixtures/cases/externalWorkerCase.cmmn b/tests/fixtures/cases/externalWorkerCase.cmmn → ...ts/fixtures/cases/externalWorkerCase.cmmn
diff --git a/.../fixtures/cassettes/test_acquire_jobs.yml → .../fixtures/cassettes/test_acquire_jobs.yml b/.../fixtures/cassettes/test_acquire_jobs.yml → .../fixtures/cassettes/test_acquire_jobs.yml
diff --git a/.../fixtures/cassettes/test_complete_job.yml → .../fixtures/cassettes/test_complete_job.yml b/.../fixtures/cassettes/test_complete_job.yml → .../fixtures/cassettes/test_complete_job.yml
diff --git a/tests/fixtures/cassettes/test_consume.yml → ...tests/fixtures/cassettes/test_consume.yml b/tests/fixtures/cassettes/test_consume.yml → ...tests/fixtures/cassettes/test_consume.yml
diff --git a/...assettes/test_consume_with_bpmn_error.yml → ...assettes/test_consume_with_bpmn_error.yml b/...assettes/test_consume_with_bpmn_error.yml → ...assettes/test_consume_with_bpmn_error.yml
diff --git a/...ttes/test_consume_with_cmmn_terminate.yml → ...ttes/test_consume_with_cmmn_terminate.yml b/...ttes/test_consume_with_cmmn_terminate.yml → ...ttes/test_consume_with_cmmn_terminate.yml
diff --git a/tests/fixtures/cassettes/test_fail_job.yml → ...ests/fixtures/cassettes/test_fail_job.yml b/tests/fixtures/cassettes/test_fail_job.yml → ...ests/fixtures/cassettes/test_fail_job.yml
diff --git a/tests/fixtures/cassettes/test_get_job.yml → ...tests/fixtures/cassettes/test_get_job.yml b/tests/fixtures/cassettes/test_get_job.yml → ...tests/fixtures/cassettes/test_get_job.yml
diff --git a/...or_without_error_code_1_execute_first.yml → ...or_without_error_code_1_execute_first.yml b/...or_without_error_code_1_execute_first.yml → ...or_without_error_code_1_execute_first.yml
diff --git a/...r_without_error_code_2_execute_second.yml → ...r_without_error_code_2_execute_second.yml b/...r_without_error_code_2_execute_second.yml → ...r_without_error_code_2_execute_second.yml
diff --git a/...rror_without_error_code_execute_first.yml → ...rror_without_error_code_execute_first.yml b/...rror_without_error_code_execute_first.yml → ...rror_without_error_code_execute_first.yml
diff --git a/...assettes/test_job_with_cmmn_terminate.yml → ...assettes/test_job_with_cmmn_terminate.yml b/...assettes/test_job_with_cmmn_terminate.yml → ...assettes/test_job_with_cmmn_terminate.yml
diff --git a/tests/fixtures/cassettes/test_list_jobs.yml → ...sts/fixtures/cassettes/test_list_jobs.yml b/tests/fixtures/cassettes/test_list_jobs.yml → ...sts/fixtures/cassettes/test_list_jobs.yml
diff --git a/...ttes/test_list_jobs_customize_session.yml → ...ttes/test_list_jobs_customize_session.yml b/...ttes/test_list_jobs_customize_session.yml → ...ttes/test_list_jobs_customize_session.yml
diff --git a/...cassettes/test_list_jobs_invalid_auth.yml → ...cassettes/test_list_jobs_invalid_auth.yml b/...cassettes/test_list_jobs_invalid_auth.yml → ...cassettes/test_list_jobs_invalid_auth.yml
diff --git a/...settes/test_subscribe_with_bpmn_error.yml → ...settes/test_subscribe_with_bpmn_error.yml b/...settes/test_subscribe_with_bpmn_error.yml → ...settes/test_subscribe_with_bpmn_error.yml
diff --git a/...ures/processes/externalWorkerProcess.bpmn → ...ures/processes/externalWorkerProcess.bpmn b/...ures/processes/externalWorkerProcess.bpmn → ...ures/processes/externalWorkerProcess.bpmn
diff --git a/...fixtures/processes/withBoundaryEvent.bpmn → ...fixtures/processes/withBoundaryEvent.bpmn b/...fixtures/processes/withBoundaryEvent.bpmn → ...fixtures/processes/withBoundaryEvent.bpmn
diff --git a/tests/test_init.py → external-worker/tests/test_init.py b/tests/test_init.py → external-worker/tests/test_init.py
diff --git a/tests/test_restclient.py → external-worker/tests/test_restclient.py b/tests/test_restclient.py → external-worker/tests/test_restclient.py
diff --git a/tests/vcr.py → external-worker/tests/vcr.py b/tests/vcr.py → external-worker/tests/vcr.py
diff --git a/robocorp/setup.py b/robocorp/setup.py
@@ -9,13 +9,13 @@
 setup(
     name='flowable.robocorp-client',
     packages=['flowable', 'flowable.robocorp_client'],
-    version='1.1.0rc1',
+    version='1.0.0rc1',
     description='Flowable client to be used with Robocorp. This client connects to a Flowable instance via external worker and executes robocorp tasks or actions.',
     long_description=long_description,
     long_description_content_type='text/markdown',
     author='Flowable',
     license='Apache License, Version 2.0',
-    install_requires=['flowable.external-worker-client>=1.1.0rc1', 'robocorp-actions>=0.2.1', 'robocorp-tasks>=3.1.1', 'robocorp-truststore>=0.9.1'],
+    install_requires=['flowable.external-worker-client>=1.0.1rc1', 'robocorp-actions>=0.2.1', 'robocorp-tasks>=3.1.1', 'robocorp-truststore>=0.9.1'],
     extras_require={
         'testing': ['pytest', 'vcrpy']
     },