semvec/pypi-packages huggingface dataset:
django-xworkflows 1.0.0
A django app enabling Django models to use xworkflows.
License: BSD
Keywords: django workflow state machine automaton

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 <http://github.com/rbarrois/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