raw_id_fields widget replacement that handles display of an object's string value on change and can be overridden via a template.
Project description
django-dynamic-raw-id
A Django admin raw_id_fields widget replacement that handles display of an object’s string value on change and can be overridden via a template. See this example:
Installation
Install the package with pip:
$ pip install django-dynamic-raw-id
Put dynamic_raw_id to your list of INSTALLED_APPS:
INSTALLED_APPS = ( # ... other apps 'dynamic_raw_id', )
And add the urlpattern:
urlpatterns = [ # ... url(r'^admin/dynamic_raw_id/', include('dynamic_raw_id.urls')), ]
dynamic_raw_id comes with some static files so don’t forget to run manage.py collectstatic.
Usage
To start using django-dynamic-raw-id in your application all you need to do is implement DynamicRawIDMixin in your ModelAdmin class and add the desired fields to a list of dynamic_raw_id_fields:
from dynamic_raw_id.admin import DynamicRawIDMixin class UserProfileAdmin(DynamicRawIDMixin, admin.ModelAdmin): dynamic_raw_id_fields = ('user',)
You can use dynamic_raw_id widgets in a Admin filter as well:
from dynamic_raw_id.admin import DynamicRawIDMixin from dynamic_raw_id.filters import DynamicRawIDFilter class UserProfileAdmin(DynamicRawIDMixin, admin.ModelAdmin): list_filter = ( ('dynamic_raw_id_fk', DynamicRawIDFilter), )
Customizing the value of the dynamic widget
The coolest feature of django-dynamic-raw-id is the ability to customize the output of the value displayed alongside the DynamicRawIDWidget. There is a basic implementation if all you want is your object’s __unicode__ value. To change the value displayed all you need to do is implement the correct template.
django-dynamic-raw-id looks for this template structure dynamic_raw_id/<app>/<model>.html and dynamic_raw_id/<app>/multi_<model>.html (for multi-value lookups).
For instance, if I have a blog post with a User dynamic_raw_id field that I want display as Firstname Lastname, I would create the template dynamic_raw_id/auth/user.html with:
<span>{{ object.0.first_name }} {{ object.0.last_name }}</span>
A custom admin URL prefix
If you have your admin and the dynamic_raw_id scripts located on a different prefix than /admin/dynamic_raw_id/ you need adjust the DYNAMIC_RAW_ID_MOUNT_URL JS variable.
Example:
# In case the script is setup at /foobar/dynamic_raw_id/ url(r'^foobar/dynamic_raw_id/', include('dynamic_raw_id.urls')), # Provide a <script> window.DYNAMIC_RAW_ID_MOUNT_URL = "{% url "admin:index" %}"; </script>
An ideal place is the admin base_site.html template. Full example:
{% extends "admin/base.html" %} {% block title %}{{ title }} | {{ site_title|default:_('Django site admin') }}{% endblock %} {% block extrahead %} {{ block.super }} <script> window.DYNAMIC_RAW_ID_MOUNT_URL = "{% url "admin:index" %}"; </script> {% endblock %} {% block branding %} <h1 id="site-name"><a href="{% url 'admin:index' %}">{{ site_header|default:_('Django administration') }}</a></h1> {% endblock %} {% block nav-global %}{% endblock %}
Testing and Local Development
The testsuite uses Selenium to do frontend tests, we require Firefox and geckodriver to be installed. You can install geckodriver on OS X with Homebrew:
$ brew install geckodriver
Run the testsuite in your local environment using:
$ cd django-dynamic-raw-id/ $ pipenv install --dev $ pipenv run python ./runtests.py
Or use tox to test against various Django and Python versions:
$ tox -r
You can also invoke the test suite or other ‘manage.py’ commands by calling the django-admin tool with the test app settings:
$ cd django-dynamic-raw-id/ $ pipenv install --dev $ pipenv run django-admin $ pipenv run django-admin test
This also allows you to run the internal testing app in a testserver, to preview a sample of what django-dynamic-raw-id is doing:
$ pipenv run django-admin migrate $ pipenv run django-admin createsuperuser $ pipenv run django-admin 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
Hashes for django-dynamic-raw-id-2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | abed3fbfd1c0a6625e6e74b65b7042522a987dbfa34c2f5c8dac8ae25b8d43c9 |
|
MD5 | 84b65ef6da3a580e896017ffb6cce915 |
|
BLAKE2b-256 | e1505ae1173c77ceb1dd7ef1a75c4bb770b0a04c34453d46c52dcc4827a463b0 |