Skip to main content

Edc custom django ModelAdmin mixins, tags and templates for clinicedc/edc projects

Project description

pypi actions codecov downloads

edc-model-admin

Edc custom django ModelAdmin mixins, tags and templates

ModelAdminFormAutoNumberMixin

Overrides ModelAdmin’s get_form to insert question numbers and the DB field names.

ModelAdminNextUrlRedirectMixin

Skips the changelist and redirects to the next CRF or Requisition listed in an edc visit schedule if “[Save and Next]” is clicked instead of “[SAVE]”

class BaseModelAdmin:

    search_fields = ("subject_identifier",)

    add_form_template = "edc_model_admin/admin/change_form.html"
    change_form_template = "edc_model_admin/admin/change_form.html"
    change_list_template = "edc_model_admin/admin/change_list.html"


@admin.register(CrfTwo)
class CrfTwoAdmin(BaseModelAdmin, ModelAdminNextUrlRedirectMixin, admin.ModelAdmin):
    show_save_next = True
    show_cancel = True

You need to use the included change_form.html to override the submit buttons on the admin form.

See also:: edc_visit_schedule

ModelAdminRedirectOnDeleteMixin

Redirects the admin form on save to a view other than the default changelist if post_url_on_delete_name is set.

@admin.register(CrfFive)
class CrfFiveAdmin(ModelAdminRedirectOnDeleteMixin, admin.ModelAdmin):

    post_url_on_delete_name = "dashboard2_app:dashboard_url"

    def post_url_on_delete_kwargs(self, request, obj):
        return {'subject_identifier': obj.subject_identifier}

You can also store url names in the request object if used together with the Middleware from edc_dashboard and edc_subject_dashboard. This is useful if you do not know the namespace until deployment.

For example, add to settings:

MIDDLEWARE=[
    ...,
    'edc_dashboard.middleware.DashboardMiddleware',
    'edc_subject_dashboard.middleware.DashboardMiddleware',
],

DASHBOARD_URL_NAMES={
    'subject_dashboard_url': 'dashboard_app:subject_dashboard_url',
},

and then declare the model admin class:

@admin.register(CrfFive)
class CrfFiveAdmin(ModelAdminRedirectOnDeleteMixin, admin.ModelAdmin):

    post_url_on_delete_name = "subject_dashboard_url"

    def post_url_on_delete_kwargs(self, request, obj):
        return {'subject_identifier': obj.subject_identifier}

ModelAdminRedirectOnDeleteMixin will attempt to get the urlname from the request object using post_url_on_delete_name as a dictionary key.

Template themes

You can change the default theme colors.

EDC_MODEL_ADMIN_CSS_THEME = "edc_indigo"

Options are:

  • edc_indigo

  • edc_deep_purple

  • edc_purple

ModelForm Save Delay

You can configure the save buttons on the CRF and PRN model forms to disable for a few seconds after clicked by the user.

# settings.py
EDC_MODEL_ADMIN_SAVE_DELAY = 3000 # delay for 3 seconds

The default is 0 seconds.

Where internet connections are slow a user may think they did not click the save button and click it again. This may lead to multiple submissions of the same form and raise an IntegrityError. Save delay disables the button for 3 seonds (or as configured) to minimize the chance of this type of error occuring.

See also ModelAdminSubjectDashboardMixin and the change_form.html.

Project details


Release history Release notifications | RSS feed

This version

1.0.3

Download files

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

Source Distribution

edc_model_admin-1.0.3.tar.gz (68.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

edc_model_admin-1.0.3-py3-none-any.whl (95.5 kB view details)

Uploaded Python 3

File details

Details for the file edc_model_admin-1.0.3.tar.gz.

File metadata

  • Download URL: edc_model_admin-1.0.3.tar.gz
  • Upload date:
  • Size: 68.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for edc_model_admin-1.0.3.tar.gz
Algorithm Hash digest
SHA256 fd31f81595c4a4b97999b5ad53dabd5914c6d2ba3ce7fe5e8da4dee57a8dd1cd
MD5 730127e59a1a80a4372828e34b497fac
BLAKE2b-256 81954c9d0dd61d8f8a54558a8a77707f99677116566bf92d2a5f9afae754a6a3

See more details on using hashes here.

File details

Details for the file edc_model_admin-1.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for edc_model_admin-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5a3655914a094b817da6720bcbf796408d81bb02c68becd571ac347fa04e8920
MD5 d1fe9ab2727f1ef819be18db686587b1
BLAKE2b-256 b1e43823e8286a5237177d29577fd1767e645894db5b4da7e1ad5c3f2043e6dc

See more details on using hashes here.

Supported by

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