Skip to main content

Integrate django-fsm-2 state transitions into the django admin

Project description

django-fsm-2-admin

Mixin and template tags to integrate django-fsm-2 state transitions into the Django Admin.

[!IMPORTANT] This project is a fork of django-fsm-admin, actively maintained and enhanced. It utilizes django-fsm-2 for state transitions in the Django Admin interface.

Installation

pip install django-fsm-2-admin

Or from GitHub:

pip install -e git://github.com/coral-li/django-fsm-2-admin.git#egg=django-fsm-2-admin

Usage

  1. Add fsm_admin to your INSTALLED_APPS.

  2. In your admin.py file, use FSMTransitionMixin to add behaviour to your ModelAdmin. FSMTransitionMixin should be before ModelAdmin, the order is important.

It assumes that your workflow state field is named state, however you can override it or add additional workflow state fields with the attribute fsm_field.

from fsm_admin.mixins import FSMTransitionMixin

class YourModelAdmin(FSMTransitionMixin, admin.ModelAdmin):
      # The name of one or more FSMFields on the model to transition
      fsm_field = ['wf_state',]

admin.site.register(YourModel, YourModelAdmin)
  1. By adding custom=dict(admin=False) to the transition decorator, one can disallow a transition to show up in the admin interface. This specially is useful, if the transition method accepts parameters without default values, since in django-fsm-2-admin no arguments can be passed into the transition method.
@transition(
   field='state',
   source=['startstate'],
   target='finalstate',
   custom=dict(admin=False),
)
def do_something(self, param):
   # will not add a button "Do Something" to your admin model interface

By adding FSM_ADMIN_FORCE_PERMIT = True to your configuration settings, the above restriction becomes the default. Then one must explicitly allow that a transition method shows up in the admin interface.

@transition(
      field='state',
      source=['startstate'],
      target='finalstate',
      custom=dict(admin=True),
)
def proceed(self):
      # will add a button "Proceed" to your admin model interface

This is useful, if most of your state transitions are handled by other means, such as external events communicating with the API of your application.

Try the example

git clone git@github.com:coral-li/django-fsm-2-admin.git
cd django-fsm-2-admin
uv venv
source .venv/bin/activate
uv pip install -r requirements-dev.txt
python setup.py develop
cd example
python manage.py migrate
python manage.py createsuperuser --username admin
python manage.py runserver

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_fsm_2_admin-2.0.1.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

django_fsm_2_admin-2.0.1-py2.py3-none-any.whl (14.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django_fsm_2_admin-2.0.1.tar.gz.

File metadata

  • Download URL: django_fsm_2_admin-2.0.1.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for django_fsm_2_admin-2.0.1.tar.gz
Algorithm Hash digest
SHA256 da7abef3721e2d79b0a4fb27a94706d2bfcddf6c343d1481646e4a9c5fa43c62
MD5 b5b3b11676bbca202ed1d4b6c8cb6556
BLAKE2b-256 2e5beadda5a2715b7facb8b045b966441c44b63fe371e3e2d05733ae556e8d08

See more details on using hashes here.

File details

Details for the file django_fsm_2_admin-2.0.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_fsm_2_admin-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7649b7b4f4e7d88cab7d608c5e35a732014c9bd1efc2a0598a24813e444b3dae
MD5 777bbcef10c10901142658c8d07b655a
BLAKE2b-256 54b09f00005a97ba91c80e160be742ebe93454cae9cd52a6fa85102f52d8732c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page