django-bpmn-widget


Namedjango-bpmn-widget JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/walirt/django-bpmn-widget
Summarydjango bpmn modeler widget(integrated with properties panel)
upload_time2022-12-21 10:09:16
maintainer
docs_urlNone
authorwalirt
requires_python>=3
license
keywords django bpmn widget
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # django-bpmn-widget ![](https://img.shields.io/badge/language-Python3-brightgreen.svg)
django bpmn modeler widget(integrated with properties panel)

## Usage
1. Install django-bpmn-widget
```shell
pip install django-bpmn-widget
```
2. Add `bpmn_widget` to `settings.py` `INSTALLED_APPS`, like this:
```python
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'bpmn_widget'
]
```
3. Display in Form
```python
from django import forms

from yourapp.models import MyModel
from bpmn_widget.widgets import BPMNWidget # import widget


class MyModelForm(forms.ModelForm):
    class Meta:
        model = MyModel
        widgets = {
            'content': BPMNWidget() # change it to the field you want to display
        }
        fields = '__all__'
```
4. Display in Django-Admin
```python
from django.contrib import admin

from yourapp.models import MyModel
from yourapp.forms import MyModelForm


class MyModelAdmin(admin.ModelAdmin):
    form = MyModelForm

admin.site.register(MyModel, MyModelAdmin)
```

## Note
The following is the js library for widget integration
- bpmn-js@10.2.1
- bpmn-js-properties-panel@1.10.0
- camunda-bpmn-moddle@7.0.1

If you want to update their version or extend other plug-ins, please compile them yourself

## Screenshot
![img.png](https://github.com/walirt/django-bpmn-widget/blob/main/screenshot/img.png?raw=true)


## Reference
[bpmn-js](https://github.com/bpmn-io/bpmn-js)  
[django-bpmn](https://github.com/jplobianco/django-bpmn)  


# License
![](https://img.shields.io/badge/License-MIT-blue.svg)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/walirt/django-bpmn-widget",
    "name": "django-bpmn-widget",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3",
    "maintainer_email": "",
    "keywords": "django,bpmn,widget",
    "author": "walirt",
    "author_email": "610577219@qq.com",
    "download_url": "https://files.pythonhosted.org/packages/30/bf/dff26f7c5e1343b691c99e5675fe807c320d3257787e3f8e6deba748c19b/django-bpmn-widget-1.0.1.tar.gz",
    "platform": null,
    "description": "# django-bpmn-widget ![](https://img.shields.io/badge/language-Python3-brightgreen.svg)\ndjango bpmn modeler widget(integrated with properties panel)\n\n## Usage\n1. Install django-bpmn-widget\n```shell\npip install django-bpmn-widget\n```\n2. Add `bpmn_widget` to `settings.py` `INSTALLED_APPS`, like this:\n```python\nINSTALLED_APPS = [\n    'django.contrib.admin',\n    'django.contrib.auth',\n    'django.contrib.contenttypes',\n    'django.contrib.sessions',\n    'django.contrib.messages',\n    'django.contrib.staticfiles',\n    'bpmn_widget'\n]\n```\n3. Display in Form\n```python\nfrom django import forms\n\nfrom yourapp.models import MyModel\nfrom bpmn_widget.widgets import BPMNWidget # import widget\n\n\nclass MyModelForm(forms.ModelForm):\n    class Meta:\n        model = MyModel\n        widgets = {\n            'content': BPMNWidget() # change it to the field you want to display\n        }\n        fields = '__all__'\n```\n4. Display in Django-Admin\n```python\nfrom django.contrib import admin\n\nfrom yourapp.models import MyModel\nfrom yourapp.forms import MyModelForm\n\n\nclass MyModelAdmin(admin.ModelAdmin):\n    form = MyModelForm\n\nadmin.site.register(MyModel, MyModelAdmin)\n```\n\n## Note\nThe following is the js library for widget integration\n- bpmn-js@10.2.1\n- bpmn-js-properties-panel@1.10.0\n- camunda-bpmn-moddle@7.0.1\n\nIf you want to update their version or extend other plug-ins, please compile them yourself\n\n## Screenshot\n![img.png](https://github.com/walirt/django-bpmn-widget/blob/main/screenshot/img.png?raw=true)\n\n\n## Reference\n[bpmn-js](https://github.com/bpmn-io/bpmn-js)  \n[django-bpmn](https://github.com/jplobianco/django-bpmn)  \n\n\n# License\n![](https://img.shields.io/badge/License-MIT-blue.svg)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "django bpmn modeler widget(integrated with properties panel)",
    "version": "1.0.1",
    "split_keywords": [
        "django",
        "bpmn",
        "widget"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9cb8f3ba17681a6c65343b099d0cd8b8",
                "sha256": "9f9955bd899aa87da9cf58f9a2d3c35ba3cc49a11a2b112735cdc075b8c41c79"
            },
            "downloads": -1,
            "filename": "django_bpmn_widget-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9cb8f3ba17681a6c65343b099d0cd8b8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3",
            "size": 988221,
            "upload_time": "2022-12-21T10:09:13",
            "upload_time_iso_8601": "2022-12-21T10:09:13.268961Z",
            "url": "https://files.pythonhosted.org/packages/ae/64/fc1eeefb66649a1e5af032334b7304f453af29c512109baeca5384844335/django_bpmn_widget-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "788fca138457dee5f278717ab55ca261",
                "sha256": "2eb46d38c92c603c83334447144e8ab8b8e8699a05ba14134003d2a6b9dff64f"
            },
            "downloads": -1,
            "filename": "django-bpmn-widget-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "788fca138457dee5f278717ab55ca261",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3",
            "size": 977524,
            "upload_time": "2022-12-21T10:09:16",
            "upload_time_iso_8601": "2022-12-21T10:09:16.586360Z",
            "url": "https://files.pythonhosted.org/packages/30/bf/dff26f7c5e1343b691c99e5675fe807c320d3257787e3f8e6deba748c19b/django-bpmn-widget-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-21 10:09:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "walirt",
    "github_project": "django-bpmn-widget",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "django-bpmn-widget"
}
walirt
Elapsed time: 0.02450s