Django River

River is an open source and always free workflow framework for Django which support on the fly changes instead of hardcoding states, transitions and authorization rules.

The main goal of developing this framework is to be able to edit any workflow item on the fly. This means that all the elements in a workflow like states, transitions or authorizations rules are editable at any time so that no changes requires a re-deploying of your application anymore.

Donations

This is a fully open source project and it can be better with your donations.

If you are using django-river to create a commercial product, please consider becoming our sponsor , patron or donate over PayPal

Advance Admin

A very modern admin with some user friendly interfaces that is called River Admin has been published.

Getting Started

You can easily get started with django-river by following Getting Started.

Contents

• Getting Started
• Overview
  • Requirements
  • Supported (Tested) Databases:
  • Example Scenarios
• Administration
  • State Administration
  • Transition Meta Administration
  • Transition Approval Meta Administration
• API Guide
  • Class API
  • Instance API
• Authorization
  • Permission Based Authorization
  • User Group Based Authorization
  • User Based Authorization
• Hooking Guide
  • Functions
  • Hook it Up
• FAQ
  • What does “supporting on-the-fly changes” mean?
  • What are the advantages of dynamic workflows?
  • What are the disadvantages of dynamic workflows?
  • What are the differences between django-river and viewflow?
  • What are the differences between django-river and django-fsm?
  • Can I have multiple initial states in a workflow?
  • Can I have a workflow that circulates?
  • Is there a limit on how many states I can have in a workflow?
  • Can I have an authorization rule consist of two user groups? (Horizontal Authorization Rules)
  • Can I have two authorization rules for one transition and have one of them wait the other? (Vertical Authorization Rules)
  • Can I have two state fields in one Django model?
  • Can I have two workflow in parallel?
  • Can I have two workflow in different Django models?
  • Does it support all the databases that are supported by Django?
  • What happens to the existing workflow object if I add a new transition to the workflow?
  • Can I add a new hook on-the-fly?
  • Can I delete an existing hook on-the-fly?
  • Can I modify a the source code of the function that is used in the hooks on-the-fly?
  • Is there any delay for functions updates?
  • Can I use django-river with sqlalchemy?
  • What is the difference between Class API and Instance API?
  • What is the error 'ClassWorkflowObject' object has no attribute 'approve'?
  • What is the error There is no available approval for the user.?
• Migration Guide
  • 2.X.X to 3.0.0
  • 3.1.X to 3.2.X
• Change Logs
  • 3.2.0 (Stable):
  • 3.1.4
  • 3.1.3:
  • 3.1.2:
  • 3.1.1
  • 3.1.0
  • 3.0.0
  • 2.0.0
  • 1.0.2
  • 1.0.1
  • 1.0.0
  • 0.10.0
  • 0.9.0
  • 0.8.2
  • 0.8.1
  • 0.8.0
  • 0.7.0
  • 0.6.2
  • 0.6.1
  • 0.6.0
  • 0.5.3
  • 0.5.2
  • 0.5.1

Indices and tables

• Index
• Module Index
• Search Page