https://github.com/pklauke/pycamunda

Python REST api client for the workflow and decision automation engine Camunda.
https://github.com/pklauke/pycamunda

camunda camunda-bpm-platform camunda-external-task python rest-client

Last synced: 3 months ago
JSON representation

Python REST api client for the workflow and decision automation engine Camunda.

• Host: GitHub
• URL: https://github.com/pklauke/pycamunda
• Owner: pklauke
• License: mit
• Created: 2020-02-13T18:37:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-09-12T13:29:07.000Z (about 1 year ago)
• Last Synced: 2024-07-23T17:54:22.268Z (3 months ago)
• Topics: camunda, camunda-bpm-platform, camunda-external-task, python, rest-client
• Language: Python
• Homepage:
• Size: 439 KB
• Stars: 43
• Watchers: 2
• Forks: 13
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.com/pklauke/pycamunda.svg?branch=master)](https://travis-ci.com/pklauke/pycamunda)

[![codecov](https://codecov.io/gh/pklauke/pycamunda/branch/master/graph/badge.svg)](https://codecov.io/gh/pklauke/pycamunda)

[![Documentation Status](https://readthedocs.org/projects/pycamunda/badge/?version=latest)](https://pycamunda.readthedocs.io/en/latest/?badge=latest)

# PyCamunda

PyCamunda is a Python REST api client for the workflow and decision automation engine Camunda. 

PyCamunda takes care of Camunda-specific characteristics and gives you an intuitive Python interface so you can focus on developing your actual business application. So PyCamunda deals with http requests, nested dictionaries, camelCase keys,  datetime formatting and more for you.

Simply..

* .. create an instance of the PyCamunda class corresponding to a Camunda endpoint,

* .. configure it using keyword arguments and methods,

* .. send the request and get the response serialized in a Python data class.

```python

import pycamunda.processinst

url = 'http://localhost/engine-rest'

get_instances = pycamunda.processinst.GetList(url, process_definition_key='MyProcess')

instances = get_instances()

for instance in instances:

    print('Process instance id:', instance.id_)

```

Output:

```console

Process instance id: 174cb832-a8a7-11ea-8129-0242ac110002

Process instance id: 1a70a8e9-a7ed-11ea-8129-0242ac110002

...

```

## Installation

PyCamunda requires Python >= 3.7 and can be installed from the offical Python Package Index.

```

$ pip install pycamunda

```

## Documentation

The latest documentation can be found here.