Camunda client for Django
=========================
:Version: 0.15.0
:Source: https://github.com/maykinmedia/django-camunda
:Keywords: camunda, process engine, bpmn
|build-status| |linting| |coverage|
|python-versions| |django-versions| |pypi-version|
Interact with Camunda BPMN processes from Django projects.
.. contents::
.. section-numbering::
Tested against Camunda 7.16
Features
========
* Configure Camunda connection parameters from the admin
* Shared Celery tasks
* Domain models as Python objects
* Complex/custom process variable support
* DMN evaluation and introspection
Installation
============
Requirements
------------
* Python 3.10+
* Django 4.2+
* Celery [optional]
Install
-------
.. code-block:: bash
pip install django-camunda
or with Celery support:
.. code-block:: bash
pip install django-camunda[celery]
Next, ensure the following apps are installed:
.. code-block:: python
INSTALLED_APPS = [
...,
"solo",
"django_camunda",
...
]
and run migrations:
.. code-block:: bash
python manage.py migrate
Usage
=====
Configuration
-------------
1. In the admin, navigate to **django-camunda** > **Camunda configuration**
2. Fill out the API connection parameters for your Camunda instance
Using the API client
--------------------
**Built-in API functions**
The module ``django_camunda.api`` contains a number of pre-defined API endpoint
bindings. If what you're looking for does not exist (yet), you can use the low-level
API client (see below).
**Core usage**
The Camunda client class is a wrapper around the
`requests <https://pypi.org/project/requests/>`_ library and as such aims to provide
the same Python interface.
.. code-block:: python
from django_camunda.client import get_client
with get_client() as client:
task = client.get("task/5c793356-24f5-4f82-a5ce-a3cce43b762b")
... # do something with the task details
.. |build-status| image:: https://github.com/maykinmedia/django-camunda/workflows/Run%20CI/badge.svg
:target: https://github.com/maykinmedia/django-camunda/actions?query=workflow%3A%22Run+CI%22
:alt: Run CI
.. |linting| image:: https://github.com/maykinmedia/django-camunda/workflows/Code%20quality%20checks/badge.svg
:target: https://github.com/maykinmedia/django-camunda/actions?query=workflow%3A%22Code+quality+checks%22
:alt: Code linting
.. |coverage| image:: https://codecov.io/gh/maykinmedia/django-camunda/branch/master/graph/badge.svg
:target: https://codecov.io/gh/maykinmedia/django-camunda
:alt: Coverage status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-camunda.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-camunda.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/django-camunda.svg
:target: https://pypi.org/project/django-camunda/
Raw data
{
"_id": null,
"home_page": "https://github.com/maykinmedia/django-camunda",
"name": "django-camunda",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "camunda, process engine, bpmn, common ground",
"author": "Maykin Media",
"author_email": "support@maykinmedia.nl",
"download_url": "https://files.pythonhosted.org/packages/c4/4c/1a30c2384ed29c34bcc26cd44b0fa29413d523030646e107441110ff44c2/django_camunda-0.15.0.tar.gz",
"platform": null,
"description": "Camunda client for Django\n=========================\n\n:Version: 0.15.0\n:Source: https://github.com/maykinmedia/django-camunda\n:Keywords: camunda, process engine, bpmn\n\n|build-status| |linting| |coverage|\n\n|python-versions| |django-versions| |pypi-version|\n\nInteract with Camunda BPMN processes from Django projects.\n\n.. contents::\n\n.. section-numbering::\n\nTested against Camunda 7.16\n\nFeatures\n========\n\n* Configure Camunda connection parameters from the admin\n* Shared Celery tasks\n* Domain models as Python objects\n* Complex/custom process variable support\n* DMN evaluation and introspection\n\nInstallation\n============\n\nRequirements\n------------\n\n* Python 3.10+\n* Django 4.2+\n* Celery [optional]\n\n\nInstall\n-------\n\n.. code-block:: bash\n\n pip install django-camunda\n\nor with Celery support:\n\n.. code-block:: bash\n\n pip install django-camunda[celery]\n\nNext, ensure the following apps are installed:\n\n.. code-block:: python\n\n INSTALLED_APPS = [\n ...,\n \"solo\",\n \"django_camunda\",\n ...\n ]\n\nand run migrations:\n\n.. code-block:: bash\n\n python manage.py migrate\n\nUsage\n=====\n\nConfiguration\n-------------\n\n1. In the admin, navigate to **django-camunda** > **Camunda configuration**\n2. Fill out the API connection parameters for your Camunda instance\n\n\nUsing the API client\n--------------------\n\n**Built-in API functions**\n\nThe module ``django_camunda.api`` contains a number of pre-defined API endpoint\nbindings. If what you're looking for does not exist (yet), you can use the low-level\nAPI client (see below).\n\n**Core usage**\n\nThe Camunda client class is a wrapper around the\n`requests <https://pypi.org/project/requests/>`_ library and as such aims to provide\nthe same Python interface.\n\n.. code-block:: python\n\n from django_camunda.client import get_client\n\n with get_client() as client:\n task = client.get(\"task/5c793356-24f5-4f82-a5ce-a3cce43b762b\")\n\n ... # do something with the task details\n\n\n.. |build-status| image:: https://github.com/maykinmedia/django-camunda/workflows/Run%20CI/badge.svg\n :target: https://github.com/maykinmedia/django-camunda/actions?query=workflow%3A%22Run+CI%22\n :alt: Run CI\n\n.. |linting| image:: https://github.com/maykinmedia/django-camunda/workflows/Code%20quality%20checks/badge.svg\n :target: https://github.com/maykinmedia/django-camunda/actions?query=workflow%3A%22Code+quality+checks%22\n :alt: Code linting\n\n.. |coverage| image:: https://codecov.io/gh/maykinmedia/django-camunda/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/maykinmedia/django-camunda\n :alt: Coverage status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/django-camunda.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/django-camunda.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/django-camunda.svg\n :target: https://pypi.org/project/django-camunda/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Interact with Camunda from Django",
"version": "0.15.0",
"project_urls": {
"Homepage": "https://github.com/maykinmedia/django-camunda"
},
"split_keywords": [
"camunda",
" process engine",
" bpmn",
" common ground"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ac9a6927017115378528e0643f336eeaf5e271a52efae68835248b0787e1596",
"md5": "c7d30251210098274e10ec2fbf4fad58",
"sha256": "adf68cdbd97150359bbbf7c29f6acda5b67cfcecfdcbb3c6f81b08f12305ffed"
},
"downloads": -1,
"filename": "django_camunda-0.15.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7d30251210098274e10ec2fbf4fad58",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 27657,
"upload_time": "2024-05-08T15:27:14",
"upload_time_iso_8601": "2024-05-08T15:27:14.603336Z",
"url": "https://files.pythonhosted.org/packages/5a/c9/a6927017115378528e0643f336eeaf5e271a52efae68835248b0787e1596/django_camunda-0.15.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c44c1a30c2384ed29c34bcc26cd44b0fa29413d523030646e107441110ff44c2",
"md5": "5bf9181c3647c15792226c6b01c3b36f",
"sha256": "220282e92a05eb4458ce422dd914e0f2adb56ffebb352688667f88b403fdbf92"
},
"downloads": -1,
"filename": "django_camunda-0.15.0.tar.gz",
"has_sig": false,
"md5_digest": "5bf9181c3647c15792226c6b01c3b36f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 23689,
"upload_time": "2024-05-08T15:27:16",
"upload_time_iso_8601": "2024-05-08T15:27:16.635404Z",
"url": "https://files.pythonhosted.org/packages/c4/4c/1a30c2384ed29c34bcc26cd44b0fa29413d523030646e107441110ff44c2/django_camunda-0.15.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 15:27:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maykinmedia",
"github_project": "django-camunda",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-camunda"
}
JSON
