Module and Class References¶

Top-Level Modules¶

djblets

Authentication¶

`djblets.auth.forms`	Common forms for authentication tasks.
`djblets.auth.signals`	Authentication-related signals.
`djblets.auth.util`	Basic utility functions for authentication.
`djblets.auth.views`	Authentication-related views.

Caching¶

`djblets.cache.backend`	Utility functions for working with memory caching backends.
`djblets.cache.backend_compat`	Compatibility functions for older Django cache backend configuration.
`djblets.cache.context_processors`	Context processors for serial numbers used for front-end caching.
`djblets.cache.errors`
`djblets.cache.forwarding_backend`	A cache backend that forwards to other dynamically-configured backends.
`djblets.cache.serials`	Serial numbers used for front-end and back-end caching keys/URLs.

Config Forms¶

`djblets.configforms.forms`	Base support for configuration forms.
`djblets.configforms.pages`	Base support for configuration pages.
`djblets.configforms.views`	Standard views for displaying and interacting with configuration forms.

Datagrids¶

djblets.datagrid.grids Components for creating customizable datagrids from database data.

Database Utilities¶

`djblets.db.backends.mysql.base`	Database backend for MySQL with backported fixes.
`djblets.db.fields`
`djblets.db.managers`
`djblets.db.query`
`djblets.db.validators`

Extensions¶

`djblets.extensions.errors`
`djblets.extensions.extension`
`djblets.extensions.forms`
`djblets.extensions.hooks`
`djblets.extensions.loaders`	Template loaders for extensions.
`djblets.extensions.manager`
`djblets.extensions.middleware`
`djblets.extensions.models`
`djblets.extensions.packaging`	Packaging support for extensions.
`djblets.extensions.resources`
`djblets.extensions.settings`
`djblets.extensions.signals`
`djblets.extensions.staticfiles`
`djblets.extensions.testing`	Extension testing support.
`djblets.extensions.testing.testcases`	Mixins for test cases that need to test enabled extensions.
`djblets.extensions.urls`
`djblets.extensions.views`
`djblets.extensions.templatetags.djblets_extensions`

Feed View for RSS¶

`djblets.feedview.views`
`djblets.feedview.templatetags.feedtags`

Form Utilities¶

djblets.forms.fields

Gravatars¶

`djblets.gravatars`
`djblets.gravatars.templatetags.gravatars`

Log Handlers and Viewer¶

`djblets.log`	Logging support.
`djblets.log.middleware`	Middleware used for logging.
`djblets.log.siteconfig`
`djblets.log.urls`
`djblets.log.views`

Mail Sending¶

`djblets.mail.dmarc`	Functions for looking up DMARC entries in DNS.
`djblets.mail.message`	E-mail message composition and sending.
`djblets.mail.testing`	Testing utilities for mail-related unit tests.
`djblets.mail.utils`	General utility functions for working with e-mail.

Markdown Utilities and Extensions¶

`djblets.markdown`
`djblets.markdown.extensions.wysiwyg`
`djblets.markdown.extensions.wysiwyg_email`

Site Configuration¶

`djblets.siteconfig.context_processors`
`djblets.siteconfig.django_settings`
`djblets.siteconfig.forms`
`djblets.siteconfig.managers`
`djblets.siteconfig.middleware`
`djblets.siteconfig.models`
`djblets.siteconfig.views`

Template Utilities¶

`djblets.template.loaders.conditional_cached`
`djblets.template.loaders.namespaced_app_dirs`

Testing Helpers¶

`djblets.testing.decorators`
`djblets.testing.testcases`
`djblets.testing.testrunners`

URL Utilities¶

`djblets.urls.context_processors`
`djblets.urls.decorators`
`djblets.urls.patterns`
`djblets.urls.resolvers`
`djblets.urls.root`
`djblets.urls.staticfiles`	Utility functions for looking up static media URLs.

Generic Utilities¶

`djblets.util.contextmanagers`
`djblets.util.dates`
`djblets.util.decorators`
`djblets.util.filesystem`
`djblets.util.http`
`djblets.util.humanize`
`djblets.util.serializers`
`djblets.util.views`
`djblets.util.templatetags.djblets_deco`
`djblets.util.templatetags.djblets_email`
`djblets.util.templatetags.djblets_forms`
`djblets.util.templatetags.djblets_images`
`djblets.util.templatetags.djblets_js`
`djblets.util.templatetags.djblets_utils`

Web API¶

`djblets.webapi.auth`	Deprecated module for authentication-related functions and classes.
`djblets.webapi.auth.backends`	Base support for managing API authentication backends.
`djblets.webapi.auth.backends.api_tokens`	Authentication support for using API tokens.
`djblets.webapi.auth.backends.base`	The base class for an API authentication backend.
`djblets.webapi.auth.backends.basic`	An authentication backend for HTTP Basic Auth.
`djblets.webapi.auth.views`	Deprecated views for handling authentication.
`djblets.webapi.decorators`
`djblets.webapi.encoders`
`djblets.webapi.errors`
`djblets.webapi.managers`	Managers for API-related database models.
`djblets.webapi.models`
`djblets.webapi.resources`	Deprecated module for Web API resource classes and registration.
`djblets.webapi.resources.base`	Base class for a resource in an API.
`djblets.webapi.resources.group`	Built-in resource representing the Group model.
`djblets.webapi.resources.registry`	Resource registration and lookup.
`djblets.webapi.resources.root`	A flexible resource for the root of your API resource tree.
`djblets.webapi.resources.user`	Built-in resource representing the User model.
`djblets.webapi.resources.mixins.api_tokens`	Mixins for integrating token-based authentication into an API.
`djblets.webapi.resources.mixins.forms`	Mixins for integrating a web API resource with a form.
`djblets.webapi.resources.mixins.queries`	Mixins for helping with lookups from HTTP GET query strings.
`djblets.webapi.responses`
`djblets.webapi.testing`
`djblets.webapi.testing.decorators`	Decorators to help with API test suites.
`djblets.webapi.testing.testcases`	Test case support for full API testing.