rename module to rpaframework (#2)

rename module to rpaframework

Author: vzickner

.github/workflows/main.yml

@@ -25,11 +25,11 @@ jobs:
         working-directory: ./external-worker/
       - run: python -m unittest discover
         working-directory: ./external-worker/
-  test-robocorp-client:
+  test-rpa-framework-client:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.12.0"]
+        python-version: ["3.11.0"]
 
     steps:
       - uses: actions/checkout@v4
@@ -46,7 +46,7 @@ jobs:
       - run: python setup.py install
         working-directory: ./external-worker/
       - run: pip install -e ".[testing]"
-        working-directory: ./robocorp/
-      - run: cp -a external-worker/flowable/external_worker_client robocorp/flowable/ # we need to copy this module over, since it's only searching locally for modules
+        working-directory: ./rpaframework/
+      - run: cp -a external-worker/flowable/external_worker_client rpaframework/flowable/ # we need to copy this module over, since it's only searching locally for modules
       - run: python -m unittest discover
-        working-directory: ./robocorp/
+        working-directory: ./rpaframework/

.github/workflows/release.yml

@@ -31,7 +31,7 @@ jobs:
           packages-dir: external-worker/dist/
           verbose: true
 
-  build-robocorp-client:
+  build-rpa-framework-client:
     runs-on: ubuntu-latest
     environment: release
     permissions:
@@ -49,11 +49,11 @@ jobs:
       - run: source venv/bin/activate
       - run: pip install setuptools
       - run: python setup.py sdist
-        working-directory: ./robocorp/
+        working-directory: ./rpaframework/
       - run: pip wheel --no-deps . -w dist
-        working-directory: ./robocorp/
+        working-directory: ./rpaframework/
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          packages-dir: robocorp/dist/
+          packages-dir: rpaframework/dist/
           verbose: true

.github/workflows/test-release.yml

@@ -3,7 +3,7 @@ name: Publish Package to Test PyPi
 on:
   create:
     tags:
-      - v*
+      - 'v*'
 
 jobs:
   build-external-worker-client:
@@ -34,7 +34,7 @@ jobs:
           packages-dir: external-worker/dist/
           verbose: true
 
-  build-robocorp-client:
+  build-rpa-framework-client:
     runs-on: ubuntu-latest
     environment: release
     permissions:
@@ -52,12 +52,12 @@ jobs:
       - run: source venv/bin/activate
       - run: pip install setuptools
       - run: python setup.py sdist
-        working-directory: ./robocorp/
+        working-directory: ./rpaframework/
       - run: pip wheel --no-deps . -w dist
-        working-directory: ./robocorp/
+        working-directory: ./rpaframework/
       - 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: robocorp/dist/
+          packages-dir: rpaframework/dist/
           verbose: true

README.md

@@ -9,4 +9,4 @@ 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).
+* [RPA Framework Client](./rpaframework): A python module to execute RPA Framework tasks with the Flowable RPA Framework task (based on the external worker).

robocorp/README.md

@@ -0,0 +1 @@
+output

rpaframework/.gitignore

@@ -0,0 +1,54 @@
+# Flowable RPA Framework Client
+
+[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)
+
+This is a python module to connect a Flowable installation through an external worker with a RPA framework task.
+This allows to execute an RPA framework task from a business process with BPMN or a case diagram CMMN.
+The application is started with a task definition from RPA framework and connects to an external worker topic.
+When using the RPA framework task in Flowable, it is possible to specify a task name.
+In the task, the specific task specified will be executed and the result will be sent back to the process.
+It is required that the variables in the diagram match exactly the variables inside the RPA framework task.
+
+## Installation
+
+To install the Flowable RPA framework client, execute the following command:
+
+```
+pip install flowable.rpaframework-client
+```
+
+## Sample
+
+The following [diagram BPMN](docs/rpaframeworkExample.bpmn) illustrates a basic usage of the RPA framework task:
+
+![Simple BPMN diagram with a start event, a RPA Framework task and an end event](docs/rpaframeworkExample.png)
+
+The following example `get-weather-forecast.py` can be used as an RPA framework task:
+```
+
+```
+
+The RPA Framework worker can be started with the following command:
+```sh
+python -m flowable.rpaframework_client --flowable-token <your-token> myTopic myTask.robot
+```
+
+You can request `<your-token>` at the [Flowable Trial](https://trial.flowable.com/work/) by clicking at the bottom left on your user and go to Settings.
+Once in the settings, choose "Access Token" and press the button "New token".
+After providing name and the validity, the token is generated and can be set.
+
+Once the module is started and a process instance is created, it will automatically execute the RPA framework action and returns the result to Flowable.
+The Python module will keep running until stopped to process potential additional jobs.
+
+## Authentication
+
+Next to the cloud authentication, it's possible to authenticate against other hosts.
+The hostname can be specified with `--flowable-host`.
+
+For the authentication there are two possibilities:
+
+1. Providing a bearer token with the `--flowable-token <token>` attribute.
+2. Providing basic authentication with `--flowable-username <username>` and `--flowable-password <password>`

rpaframework/README.md

@@ -10,9 +10,9 @@
       <extensionElements>
         <flowable:externalWorkerInParameter source="city" target="city"></flowable:externalWorkerInParameter>
         <flowable:externalWorkerInParameter source="days" target="days"></flowable:externalWorkerInParameter>
-        <flowable:externalWorkerInParameter sourceExpression="get_weather_forecast" target="__robocorpTaskName"></flowable:externalWorkerInParameter>
+        <flowable:externalWorkerInParameter sourceExpression="get_weather_forecast" target="__rpaFrameworkTaskName"></flowable:externalWorkerInParameter>
         <flowable:externalWorkerOutParameter source="temperature" target="temperature"></flowable:externalWorkerOutParameter>
-        <design:stencilid><![CDATA[RobocorpTask]]></design:stencilid>
+        <design:stencilid><![CDATA[RpaFrameworkTask]]></design:stencilid>
         <design:stencilsuperid><![CDATA[ExternalWorkerTask]]></design:stencilsuperid>
       </extensionElements>
     </serviceTask>