menu

Documentation

Introduction

Viewflow is the workflow library based on BPMN concepts. BPMN - Business process modeling and notations - is the widely adopted industry standard for business process modeling. BPMN provides a standard notation readily understandable by all business stakeholders. Viewflow bridges the gap between picture and executable, ready to use web application.

After more than ten years history of the BPMN standard, it contains the whole set of battle-proven primitives for all occasions and helps you to describe all real life business process scenarios. Viewflow assists you in building a BPMN diagram in code and keep business logic separate from django forms and views code.

Viewflow suite has a modular design, and you can use viewflow core library itself, or accompanied with pre-built UI frontend.

Installation

django-viewflow works with Python 2.7 and Python 3.6 or greater, django 1.11/2.0/2.1/2.2:

pip install django-viewflow

Viewflow PRO:

pip install django-viewflow-pro  --extra-index-url https://pypi.viewflow.io/<licence_id>/simple/

To install from requirements.txt, the following statement could be added on top of the file:

--extra-index-url https://pypi.viewflow.io/<licence_id>/

3rd party documentation

You may also interest in the documentation for underline components of the Viewflow and Django-Material

• Django - The web framework for perfectionist with deadlines

• Django Filters - reusable application allows users to filter down a queryset

• Django Rest Framework - the powerful and flexible toolkit for building Web APIs.

• Materialize - The modern responsive front-end framework based on Material Design

• Turbolinks - The simple library makes navigating your web application faster

• Datatables - Advanced interaction controls for any HTML table

Read more about BPMN and Workflow

• Workflow Patterns

• Business Process Model and Notation

Introduction articles

• state machine != workflow engine

• What Is a BPMN Process (And What Is Not)

Table of Contents

• Quick start
  • Cookbook
  • Articles
  • Videos
• Core concepts
  • Flow
  • Nodes
  • This object
  • Activation
  • Models
  • Decorators
  • Locking
  • Error handling
  • Signals
• Viewflow Flow
  • Activation
  • Nodes
  • Actions views
  • Detail views
  • List views
  • Start Views
  • Task Views
  • Viewset
  • Template tags
  • View mixins
  • View utils
• Viewflow REST
  • Activation
  • Nodes
  • Serializers
  • Views
  • Viewsets
• Viewflow Frontend
• Material Forms
  • Template Tags
  • Forms Layout
  • Themes
  • Formsets and Inlines
  • Widgets
• Material Frontend
  • Modules
  • CRUD
  • Customization
• 3rd party integration
  • Celery
  • django-redis
  • django-guardian

License

Viewflow is an Open Source project licensed under the terms of the AGPL - The GNU Affero General Public License v3.0

Viewflow Pro has a commercial-friendly license allowing private forks and modifications. You can find the commercial license terms in COMM-LICENSE. Please see FAQ for more details.

Copyright

2017 Mikhail Podgurskiy <kmmbvnr@gmail.com>