Module and Class References¶

Top-Level Modules¶

`djblets`	Basic version and package information.
`djblets.deprecation`	Support for handling deprecations.

Authentication¶

`djblets.auth.forms`	Common forms for authentication tasks.
`djblets.auth.ratelimit`	Utilities for rate-limiting login attempts.
`djblets.auth.signals`	Authentication-related signals.
`djblets.auth.util`	Basic utility functions for authentication.
`djblets.auth.views`	Authentication-related views.

Avatars¶

`djblets.avatars.errors`	Avatar-specific errors.
`djblets.avatars.forms`	Forms for Djblets' avatar support.
`djblets.avatars.registry`	A registry for managing avatar services.
`djblets.avatars.services`	Djblets Avatar Services.
`djblets.avatars.services.base`	The base avatar service class implementation.
`djblets.avatars.services.fallback`	An avatar service used as a fallback to show something basic for a user.
`djblets.avatars.services.file_upload`	An avatar service for providing uploaded images.
`djblets.avatars.services.gravatar`	An avatar service for providing Gravatars.
`djblets.avatars.services.url`	An avatar service for setting absolute URLs for avatars.
`djblets.avatars.settings`	Settings managers for avatar service registries.

See also

Avatar Services Guides

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.
`djblets.cache.synchronizer`	State synchronization via caches.

Conditions¶

`djblets.conditions`	Condition rule support for applications.
`djblets.conditions.choices`	Base support and standard choices for conditions.
`djblets.conditions.conditions`	Conditions and sets of conditions.
`djblets.conditions.errors`	Error classes for conditions.
`djblets.conditions.operators`	Base support and standard operators for condition choices.
`djblets.conditions.values`	Base support and standard value field wrappers for conditions.

Config Forms¶

`djblets.configforms.forms`	Base support for configuration forms.
`djblets.configforms.mixins`	Utility mixins for configuration forms.
`djblets.configforms.pages`	Base support for configuration pages.
`djblets.configforms.registry`	A registry for configuration forms and 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`	Specialized database fields.
`djblets.db.fields.base64_field`	Field for storing data as Base64-encoded values.
`djblets.db.fields.comma_separated_values_field`	Database field for storing comma-separated values.
`djblets.db.fields.counter_field`	Field for atomically incrementing and decrementing counters in models.
`djblets.db.fields.json_field`
`djblets.db.fields.modification_timestamp_field`	Field for managing modification timestamps for a model.
`djblets.db.fields.relation_counter_field`
`djblets.db.managers`	Managers for Django database models.
`djblets.db.query`
`djblets.db.query_catcher`	Utilities for capturing and inspecting database queries.
`djblets.db.query_comparator`	Utilities for comparing executed queries to expectations.
`djblets.db.validators`

Extensions¶

`djblets.extensions.admin`	Admin site definitions for extension models.
`djblets.extensions.errors`	Error classes for extensions.
`djblets.extensions.extension`	Base classes for implementing extensions.
`djblets.extensions.forms`	Form definitions for extensions.
`djblets.extensions.hooks`	Base support and implementations for extension hooks.
`djblets.extensions.loaders`	Template loaders for extensions.
`djblets.extensions.manager`	Extension manager class for supporting extensions to an application.
`djblets.extensions.middleware`	Middleware for extensions.
`djblets.extensions.models`	Extension models.
`djblets.extensions.packaging`	Support for packaging extensions.
`djblets.extensions.resources`
`djblets.extensions.settings`	Settings API for extensions.
`djblets.extensions.signals`	Extension-related signals.
`djblets.extensions.staticfiles`	Support for looking up static files in extensions.
`djblets.extensions.testing`	Extension testing support.
`djblets.extensions.testing.testcases`	Mixins for test cases that need to test enabled extensions.
`djblets.extensions.urls`	URLs for extensions (used in the admin UI).
`djblets.extensions.views`	Views for extensions (used in the admin UI).
`djblets.extensions.templatetags.djblets_extensions`	Template tags for loading extension static media.

See also

Extension Guides

Feature Checks¶

`djblets.features`	Feature switch support for applications.
`djblets.features.checkers`	Classes for checking whether features are enabled for different criteria.
`djblets.features.decorators`	Feature-related decorators.
`djblets.features.errors`	Error classes for features.
`djblets.features.feature`	Base support for defining a feature.
`djblets.features.level`	Stability levels for a feature.
`djblets.features.registry`	Registry for managing feature registrations.
`djblets.features.testing`	Helpers for unit tests working with features.
`djblets.features.templatetags.features`	Template tags for working with features.

See also

Feature Checks Guides

Form Utilities¶

`djblets.forms.fields`	Additional fields for Django forms.
`djblets.forms.fieldsets`	Utilities related to django.contrib.admin fieldsets.
`djblets.forms.forms`	Specialized forms provided by Djblets.
`djblets.forms.forms.key_value_form`	A form for working with key/value stores.
`djblets.forms.widgets`	Custom widgets for Django form fields.

Gravatars¶

`djblets.gravatars`	Utilities for working with gravatars.
`djblets.gravatars.templatetags.gravatars`	Template tags for using gravatars.

HTTP Utilities¶

`djblets.http.middleware`	Middleware for HTTP-related processing.
`djblets.http.responses`	Specialized HTTP response classes.

Integrations¶

`djblets.integrations.errors`	Exceptions for integrations.
`djblets.integrations.forms`	Forms for configuring integrations.
`djblets.integrations.hooks`	Extension hooks for registering integrations.
`djblets.integrations.integration`	Base support for creating service integrations.
`djblets.integrations.manager`	A manager for tracking and working with integrations.
`djblets.integrations.mixins`	Mixins for classes working with integrations.
`djblets.integrations.models`	Database models for integration configuration.
`djblets.integrations.urls`	URL helpers for integrations.
`djblets.integrations.views`	Views for working with integrations.

See also

Integration Guides

Log Handlers and Viewer¶

`djblets.log`	Logging support.
`djblets.log.middleware`	Middleware used for logging.
`djblets.log.siteconfig`	Siteconfig definitions for the log app.
`djblets.log.urls`
`djblets.log.views`	Views for the log app.

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.escape_html`	Markdown extension to safely escape HTML content.
`djblets.markdown.extensions.wysiwyg`	Markdown extension to render content similar to the source.
`djblets.markdown.extensions.wysiwyg_email`	Markdown extension to render content similar to the source in e-mails.

Django Pipeline Additions¶

`djblets.pipeline.compilers.es6`	A specialization of pipeline's ES6Compiler.
`djblets.pipeline.compilers.less`	A specialization of pipeline's LessCompiler.
`djblets.pipeline.compilers.mixins`	Mixins for writing Pipeline compilers.
`djblets.pipeline.compilers.rollup`	Pipeline compiler for bundling modern JavaScript with rollup.js.
`djblets.pipeline.compilers.typescript`	A pipeline compiler for TypeScript.
`djblets.pipeline.settings`	Utilities and constants for configuring Pipeline.

Privacy Protection¶

`djblets.privacy.consent`	Support for tracking and looking up user consent for privacy rights.
`djblets.privacy.consent.base`	Base support for consent types, data, and requirements.
`djblets.privacy.consent.common`	Common consent requirements for use in applications.
`djblets.privacy.consent.errors`	Error classes for user consents.
`djblets.privacy.consent.forms`	Forms, fields, and widgets for gathering and displaying consent.
`djblets.privacy.consent.hooks`	Extension hooks for consent requirements.
`djblets.privacy.consent.registry`	Registry for things that require consent from a user.
`djblets.privacy.consent.tracker`	Consent tracking and storage capabilities.
`djblets.privacy.models`	Database models for privacy-related data storage.
`djblets.privacy.pii`	Functions for safeguarding personally identifiable information.
`djblets.privacy.templatetags.djblets_privacy`	Privacy-related template tags.

See also

Privacy Compliance Guides

reCAPTCHA¶

`djblets.recaptcha.mixins`	Mixins for providing reCAPTCHA validation support in forms.
`djblets.recaptcha.siteconfig`
`djblets.recaptcha.templatetags.djblets_recaptcha`
`djblets.recaptcha.widgets`

See also

reCAPTCHA Guides

Registries¶

`djblets.registries`
`djblets.registries.errors`	Exception classes for dealing with Djblets registries.
`djblets.registries.importer`	Import utilities for registries.
`djblets.registries.mixins`	Utility mixins for registries.
`djblets.registries.registry`	Djblets registries.
`djblets.registries.signals`	Signals for being notified on registry operations.

See also

Registries Guides

Secrets¶

`djblets.secrets`	Utilities for working with secrets and tokens.
`djblets.secrets.crypto`	Encryption/decryption utilities.
`djblets.secrets.token_generators`	Token generators for creating access tokens.
`djblets.secrets.token_generators.base`	Base class for token generators.
`djblets.secrets.token_generators.legacy_sha1`	Token generator for legacy SHA1 tokens.
`djblets.secrets.token_generators.registry`	Registry for token generators.
`djblets.secrets.token_generators.vendor_checksum`	Generator for tokens that contain an identifiable prefix and checksum.

Site Configuration¶

`djblets.siteconfig`
`djblets.siteconfig.admin`	Administration UI registrations for site configurations.
`djblets.siteconfig.context_processors`	Template context processors for SiteConfiguration information.
`djblets.siteconfig.django_settings`	Utilities for going between SiteConfiguration and Django settings.
`djblets.siteconfig.forms`	A base form for working with settings stored on SiteConfigurations.
`djblets.siteconfig.managers`	Model and cache management for SiteConfiguration.
`djblets.siteconfig.middleware`	Middleware for managing site configurations.
`djblets.siteconfig.models`	Database models for storing site configuration.
`djblets.siteconfig.signals`
`djblets.siteconfig.views`	Views for working with site configurations.

Template Utilities¶

`djblets.template.caches`	Utility functions for working with template-related caches.
`djblets.template.context`	Utility functions for working with template contexts.
`djblets.template.loaders.conditional_cached`
`djblets.template.loaders.namespaced_app_dirs`

Testing Helpers¶

`djblets.testing.decorators`
`djblets.testing.testcases`	Base class for test cases in Django-based applications.
`djblets.testing.testrunners`

URL Utilities¶

`djblets.urls.context_processors`
`djblets.urls.decorators`
`djblets.urls.patterns`
`djblets.urls.resolvers`
`djblets.urls.root`	URL patterns for applications that can use SITE_ROOT.
`djblets.urls.staticfiles`	Utility functions for looking up static media URLs.

Generic Utilities¶

`djblets.util.compat.django.core.cache`
`djblets.util.compat.python.past`	Compatibility for features removed in Python 3.
`djblets.util.contextmanagers`	Miscellaneous utilities.
`djblets.util.dates`	Utilities for working with dates.
`djblets.util.decorators`	Miscellaneous, useful decorators.
`djblets.util.filesystem`	Filesystem-related utilities.
`djblets.util.functional`	Utilities for working with functional code.
`djblets.util.html`	HTML-related utilities.
`djblets.util.http`	HTTP-related utilities.
`djblets.util.humanize`	Functions to humanize values.
`djblets.util.json_utils`
`djblets.util.properties`	Specialized descriptors/properties for classes.
`djblets.util.serializers`	Utilities for serializing content.
`djblets.util.symbols`	Common symbols useful for function signatures.
`djblets.util.templatetags.djblets_deco`	Decorative template tags.
`djblets.util.templatetags.djblets_email`	E-mail formatting template tags.
`djblets.util.templatetags.djblets_forms`	Form-related template tags.
`djblets.util.templatetags.djblets_images`	Image-related template tags.
`djblets.util.templatetags.djblets_js`	JavaScript-related template tags.
`djblets.util.templatetags.djblets_utils`	Miscellaneous utility template tags.
`djblets.util.typing`	Common type definitions used for Djblets and consuming projects.
`djblets.util.views`	Various utility views.

View Helpers¶

`djblets.views.generic.base`	Base classes and mixins for new class-based generic views.
`djblets.views.generic.etag`	Mixin for class-based views that support ETags.

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.backends.oauth2_tokens`	Web API support for OAuth2 authentication.
`djblets.webapi.auth.views`	Deprecated views for handling authentication.
`djblets.webapi.decorators`	Decorators used for WebAPI views.
`djblets.webapi.encoders`
`djblets.webapi.errors`	Error classes and codes for WebAPI.
`djblets.webapi.fields`	Representations of field types in the API.
`djblets.webapi.managers`	Managers for API-related database models.
`djblets.webapi.models`
`djblets.webapi.oauth2_scopes`	OAuth2 scope generation for WebAPI resources.
`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.oauth2_tokens`	Web API resource support for OAuth2 token access.
`djblets.webapi.resources.mixins.queries`	Mixins for helping with lookups from HTTP GET query strings.
`djblets.webapi.responses`	HTTP responses for Web APIs.
`djblets.webapi.signals`	Web API signals.
`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.

See also

Web API Guides