django-adminwidgetswap/README at master · davisd/django-adminwidgetswap · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
django-adminwidgetswap
===============
adminwidgetswap is used for dynamically swapping out widgets from django's generated admin.

This allows applications to be packaged generically without the need for WYSIWYG dependencies editors- giving the application consumer the freedom to chose admin widgets without modifying original app source.


Installation
============

A setup script (setup.py) is provided.  To install, simply run the script with
the install command:

$ python setup.py install

Or just put the adminwidgetswap.py module somewhere on the Python path.


Usage
===============
To change a widget in django's admin, just put adminwidgetswap.py on the python path, import adminwidgetswap.py and use:

    adminwidgetswap.swap_model_field(model, field, widget)

...to change a widget for a direct model admin's field

or

    adminwidgetswap.swap_model_inline_field(model, field, widget)

...to change widgets for inlines of a specific model and field

or

    adminwidgetswap.swap_model_and_inline_fields(model, field, widget)

...to change both the widget for the direct model admin's field as well as all inline usages for the model and field

I usually have a project-level application called website, and I put this initialization code inside the website app's __init__.py


Usage - parameters
===============
model is the Model class
(eg. models.GalleryImage)

field is the field name you're looking to swap
(eg. 'image')

widget is the widget you're going to swap for
(eg. widgetlibrary.ThumbnailWidget())


Author
======
[David Davis](http://www.davisd.com)
(http://www.davisd.com)
[dynamically change django admin widets at runtime (django-adminwidgetswap) blog post](http://www.davisd.com/blog/2010/04/17/dynamically-change-django-admin-widgets-at-runtime/)