Developer Docs

Note

This documentation page is aimed at developers who want to customize, change or extend the code of OpenWISP Utils in order to modify its behavior (e.g.: for personal or commercial purposes or to fix a bug, implement a new feature or contribute to the project in general).

If you aren't a developer and you are looking for information on how to use OpenWISP, please refer to:

• General OpenWISP Quickstart

• OpenWISP Utils User Docs

• Developer Installation Instructions
  • Installing for Development
  • Alternative Sources
• OpenWISP Dashboard
  • register_dashboard_template
  • unregister_dashboard_template
  • register_dashboard_chart
  • unregister_dashboard_chart
• Main Navigation Menu
  • Context Processor
  • The register_menu_group function
  • The register_menu_subitem function
  • How to Use Custom Icons in the Menu
• Using the admin_theme
  • Using DependencyLoader and DependencyFinder
  • Supplying Custom CSS and JS for the Admin Theme
• Database Backends
  • openwisp_utils.db.backends.spatialite
• Quality Assurance Checks
  • openwisp-qa-format
  • openwisp-qa-check
  • checkmigrations
  • checkcommit
  • checkendline
  • checkpendingmigrations
  • checkrst
• Custom Fields
  • openwisp_utils.fields.KeyField
  • openwisp_utils.fields.FallbackBooleanChoiceField
  • openwisp_utils.fields.FallbackCharChoiceField
  • openwisp_utils.fields.FallbackCharField
  • openwisp_utils.fields.FallbackURLField
  • openwisp_utils.fields.FallbackTextField
  • openwisp_utils.fields.FallbackPositiveIntegerField
  • openwisp_utils.fields.FallbackDecimalField
• Admin Utilities
  • openwisp_utils.admin.TimeReadonlyAdminMixin
  • openwisp_utils.admin.ReadOnlyAdmin
  • openwisp_utils.admin.AlwaysHasChangedMixin
  • openwisp_utils.admin.CopyableFieldsAdmin
  • openwisp_utils.admin.UUIDAdmin
  • openwisp_utils.admin.ReceiveUrlAdmin
  • openwisp_utils.admin.HelpTextStackedInline
  • openwisp_utils.admin_theme.filters.InputFilter
  • openwisp_utils.admin_theme.filters.SimpleInputFilter
  • openwisp_utils.admin_theme.filters.AutocompleteFilter
  • Customizing the Submit Row in OpenWISP Admin
• Test Utilities
  • openwisp_utils.tests.catch_signal
  • openwisp_utils.tests.TimeLoggingTestRunner
  • openwisp_utils.tests.capture_stdout
  • openwisp_utils.tests.capture_stderr
  • openwisp_utils.tests.capture_any_output
  • openwisp_utils.tests.AssertNumQueriesSubTestMixin
  • openwisp_utils.test_selenium_mixins.SeleniumTestMixin
• Other Utilities
  • Model Utilities
  • REST API Utilities
  • Storage Utilities
  • Other Utilities
• Re-usable GitHub Workflows
  • Replicate Commits to Version Branch

Other useful resources:

• Settings