https://github.com/rbarrois/django_xworkflows

Library to plug xworkflows into django models.
https://github.com/rbarrois/django_xworkflows

Last synced: about 1 month ago
JSON representation

Library to plug xworkflows into django models.

• Host: GitHub
• URL: https://github.com/rbarrois/django_xworkflows
• Owner: rbarrois
• License: bsd-2-clause
• Created: 2011-07-08T13:55:06.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2021-05-01T16:37:39.000Z (about 3 years ago)
• Last Synced: 2024-04-13T20:17:44.378Z (3 months ago)
• Language: Python
• Homepage:
• Size: 275 KB
• Stars: 104
• Watchers: 11
• Forks: 40
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • Changelog: ChangeLog
  • License: LICENSE

Lists

• awesome-django - django-xworkflows - Library to plug xworkflows into django models. (Workflows)
• awesome-django - django-xworkflows - Library to plug xworkflows into django models. (Workflows)

README

        
Django-XWorkflows

=================

.. image:: https://secure.travis-ci.org/rbarrois/django_xworkflows.png?branch=master

    :target: http://travis-ci.org/rbarrois/django_xworkflows/

.. image:: https://img.shields.io/pypi/v/django_xworkflows.svg

    :target: https://django-xworkflows.readthedocs.io/en/latest/changelog.html

    :alt: Latest Version

.. image:: https://img.shields.io/pypi/pyversions/django_xworkflows.svg

    :target: https://pypi.python.org/pypi/django_xworkflows/

    :alt: Supported Python versions

.. image:: https://img.shields.io/pypi/wheel/django_xworkflows.svg

    :target: https://pypi.python.org/pypi/django_xworkflows/

    :alt: Wheel status

.. image:: https://img.shields.io/pypi/l/django_xworkflows.svg

    :target: https://pypi.python.org/pypi/django_xworkflows/

    :alt: License

Use `XWorkflows `_ along with Django models.

Django-XWorkflows allow to bind a Django model to a workflow, with a few extra features:

- Auto-save after transitions

- Log each action into the database

Define a workflow and add it to a model:

.. code-block:: python

    from django import models

    from django_xworkflows import models as xwf_models

    class MyWorkflow(xwf_models.Workflow):

        states = (

            ('new', _(u"New")),

            ('old', _(u"Old")),

        )

        transitions = (

            ('get_old', 'new', 'old'),

        )

        initial_state = 'new'

    class MyModel(xwf_models.WorkflowEnabled, models.Model):

        state = xwf_models.StateField(MyWorkflow)

Use the workflow:

.. code-block:: python

    >>> obj = MyModel()

    >>> obj.state  # Defaults to the initial_state

    State('new')

    >>> # Perform a transition

    >>> obj.get_old()

    >>> obj.state

    State('old')

    >>> # Object was saved to the database

    >>> obj.pk

    1

    >>> # Logs were saved to the database

    >>> xwf_models.TransitionLog.objects.all()

    [TransitionLog(MyModel: new -> old at 2012-04-14T12:10:00+0200)]

Links

-----

* Package on PyPI: http://pypi.python.org/pypi/django-xworkflows

* Repository and issues on GitHub: http://github.com/rbarrois/django_xworkflows

* Doc on https://django-xworkflows.readthedocs.io/

* XWorkflows on GitHub: http://github.com/rbarrois/xworkflows