add initial python library project structure

Author: vzickner

.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+*.iml

README.md

@@ -0,0 +1,2 @@
+# Flowable External Worker Library for Python
+

docker-compose.yml

@@ -0,0 +1,93 @@
+version: '3.4'
+
+services:
+  database:
+    image: postgres:14.2
+    environment:
+      POSTGRES_DB: flowable
+      POSTGRES_USER: flowable
+      POSTGRES_PASSWORD: flowable
+    volumes:
+      - data_db:/var/lib/postgresql/data
+
+  elasticsearch:
+    image: docker.elastic.co/elasticsearch/elasticsearch:7.17.3
+    environment:
+      discovery.type: single-node
+      node.name: flowable-node-01
+      cluster.name: flowable-cluster
+      xpack.security.enabled: "false"
+    volumes:
+      - data_es:/usr/share/elasticsearch/data
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+
+  flowable-work:
+    image: artifacts.flowable.com/flowable/flowable-work:3.14.0
+    environment:
+      flowable.content.storage.root-folder: /content-storage
+      server.servlet.context-path: /
+      spring.elasticsearch.uris: http://elasticsearch:9200
+      spring.datasource.driver-class-name: org.postgresql.Driver
+      spring.datasource.url: jdbc:postgresql://database:5432/flowable
+      spring.datasource.username: flowable
+      spring.datasource.password: flowable
+    ports:
+      - 8090:8080
+    volumes:
+      - data_work:/content-storage
+    depends_on:
+      - database
+      - elasticsearch
+    user: root
+    deploy:
+      restart_policy:
+        condition: on-failure
+        delay: 5s
+        max_attempts: 3
+        window: 120s
+
+  flowable-design:
+    image: artifacts.flowable.com/flowable/flowable-design:3.14.0
+    environment:
+      flowable.design.remote.authentication.user: admin
+      flowable.design.remote.authentication.password: test
+      flowable.design.remote.idm-url: http://flowable-work:8080
+      flowable.design.deployment-api-url: http://flowable-work:8080/app-api
+      flowable.design.undeployment-api-url: http://flowable-work:8080/platform-api/app-deployments
+      flowable.design.db-store-enabled: "true"
+      server.servlet.context-path: /
+      spring.datasource.driver-class-name: org.postgresql.Driver
+      spring.datasource.url: jdbc:postgresql://database:5432/flowable
+      spring.datasource.username: flowable
+      spring.datasource.password: flowable
+    ports:
+      - 8091:8080
+    depends_on:
+      - database
+
+  flowable-control:
+    image: artifacts.flowable.com/flowable/flowable-control:3.14.0
+    environment:
+      flowable.common.app.idm-admin.user: admin
+      flowable.common.app.idm-admin.password: test
+      flowable.control.app.cluster-config.server-address: http://flowable-work
+      flowable.control.app.cluster-config.port: 8080
+      flowable.control.app.cluster-config.context-root: /
+      flowable.control.app.cluster-config.password: test
+      server.servlet.context-path: /
+      spring.datasource.driver-class-name: org.postgresql.Driver
+      spring.datasource.url: jdbc:postgresql://database:5432/flowable
+      spring.datasource.username: flowable
+      spring.datasource.password: flowable
+    ports:
+      - 8092:8080
+    depends_on:
+      - database
+
+volumes:
+  data_db:
+  data_es:
+  data_work:

flowableexternalworker/__init__.py

@@ -0,0 +1,124 @@
+from datetime import datetime
+from typing import Generic, TypeVar, Callable
+
+import requests
+from requests import Session
+from requests.auth import AuthBase
+
+T = TypeVar('T')
+
+
+class ListResult(Generic[T]):
+    def __init__(self, data, total, start, sort, order, size) -> None:
+        self.data: list[T] = data
+        self.total: int = total
+        self.start: int = start
+        self.sort: str = sort
+        self.order: str = order
+        self.size: int = size
+
+
+class FlowableRestException(Exception):
+    def __init__(self, status_code, content=None):
+        if content is not None and content != '':
+            super().__init__("Failed to call Flowable with status code " + str(status_code) + " and content '" + content + "'")
+        else:
+            super().__init__("Failed to call Flowable with status code " + str(status_code))
+
+
+class ExternalWorkerJob(object):
+    def __init__(
+            self,
+            id,
+            url,
+            correlation_id,
+            process_instance_id,
+            execution_id,
+            scope_id,
+            sub_scope_id,
+            scope_definition_id,
+            scope_type,
+            element_id,
+            element_name,
+            retries,
+            exception_message,
+            due_date,
+            create_time,
+            tenant_id,
+            lock_owner,
+            lock_expiration_time
+    ):
+        self.id: str = id
+        self.url: str = url
+        self.correlation_id: str = correlation_id
+        self.process_instance_id: str = process_instance_id
+        self.execution_id: str = execution_id
+        self.scope_id: str = scope_id
+        self.sub_scope_id: str = sub_scope_id
+        self.scope_definition_id: str = scope_definition_id
+        self.scope_type: str = scope_type
+        self.element_id: str = element_id
+        self.element_name: str = element_name
+        self.retries: int = retries
+        self.exception_message: str = exception_message
+        self.due_date: datetime = due_date
+        self.create_time: datetime = create_time
+        self.tenant_id: str = tenant_id
+        self.lock_owner: str = lock_owner
+        self.lock_expiration_time: datetime = lock_expiration_time
+
+
+class FlowableExternalWorkerRestClient(object):
+    """
+    Create a REST API Client for the Flowable External Worker.
+    Used to communicate with the REST API and exchange information.
+    """
+
+    def __init__(self, flowable_host: str, auth: AuthBase = None, customize_session: Callable[[Session], None] = lambda session: None) -> None:
+        self.flowable_host: str = flowable_host
+        self.request_session: Session = requests.Session()
+        if auth is not None:
+            self.request_session.auth = auth
+        if customize_session is not None:
+            customize_session(self.request_session)
+
+    def list_jobs(self) -> ListResult[ExternalWorkerJob]:
+        r = self.request_session.get(self.flowable_host + '/external-job-api/jobs')
+
+        if r.status_code != 200:
+            raise FlowableRestException(r.status_code, r.text)
+
+        result = r.json()
+        jobs = list(map(lambda o: ExternalWorkerJob(
+            o.get('id'),
+            o.get('url'),
+            o.get('correlationId'),
+            o.get('processInstanceId'),
+            o.get('executionId'),
+            o.get('scopeId'),
+            o.get('subScopeId'),
+            o.get('scopeDefinitionId'),
+            o.get('scopeType'),
+            o.get('elementId'),
+            o.get('elementName'),
+            o.get('retries'),
+            o.get('exceptionMessage'),
+            parse_date_time(o.get('dueDate')),
+            parse_date_time(o.get('createTime')),
+            o.get('tenantId'),
+            o.get('lockOwner'),
+            parse_date_time(o.get('lockExpirationTime')),
+        ), result.get('data')))
+
+        return ListResult(
+            jobs,
+            result.get('total'),
+            result.get('start'),
+            result.get('sort'),
+            result.get('order'),
+            result.get('size')
+        )
+
+
+def parse_date_time(date):
+    return datetime.strptime(date, "%Y-%m-%dT%H:%M:%S.%fZ") if date is not None else None

flowableexternalworker/restclient.py

@@ -0,0 +1,14 @@
+from setuptools import find_packages, setup
+
+setup(
+    name='flowableexternalworker',
+    packages=find_packages(include=['flowableexternalworker']),
+    version='0.0.1',
+    description='Flowable External Worker Library to write code using an external worker.',
+    author='Flowable',
+    license='',
+    install_requires=['requests'],
+    setup_requires=['pytest-runner'],
+    tests_require=['pytest'],
+    test_suite='tests',
+)