Module and Class References¶
Top-Level Modules¶
Basic version and package information. |
|
Support for handling deprecations. |
Authentication¶
Common forms for authentication tasks. |
|
Utilities for rate-limiting login attempts. |
|
Authentication-related signals. |
|
Basic utility functions for authentication. |
|
Authentication-related views. |
Avatars¶
Avatar-specific errors. |
|
Forms for Djblets' avatar support. |
|
A registry for managing avatar services. |
|
Djblets Avatar Services. |
|
The base avatar service class implementation. |
|
An avatar service used as a fallback to show something basic for a user. |
|
An avatar service for providing uploaded images. |
|
An avatar service for providing Gravatars. |
|
An avatar service for setting absolute URLs for avatars. |
|
Settings managers for avatar service registries. |
See also
Caching¶
Utility functions for working with memory caching backends. |
|
Compatibility functions for older Django cache backend configuration. |
|
Context processors for serial numbers used for front-end caching. |
|
A cache backend that forwards to other dynamically-configured backends. |
|
Serial numbers used for front-end and back-end caching keys/URLs. |
|
Conditions¶
Condition rule support for applications. |
|
Base support and standard choices for conditions. |
|
Conditions and sets of conditions. |
|
Error classes for conditions. |
|
Base support and standard operators for condition choices. |
|
Base support and standard value field wrappers for conditions. |
Config Forms¶
Base support for configuration forms. |
|
Utility mixins for configuration forms. |
|
Base support for configuration pages. |
|
A registry for configuration forms and pages. |
|
Standard views for displaying and interacting with configuration forms. |
Datagrids¶
Components for creating customizable datagrids from database data. |
Database Utilities¶
Database backend for MySQL with backported fixes. |
|
Specialized database fields. |
|
Field for storing data as Base64-encoded values. |
|
Field for atomically incrementing and decrementing counters in models. |
|
Field for managing modification timestamps for a model. |
|
Managers for Django database models. |
|
Extensions¶
Admin site definitions for extension models. |
|
Error classes for extensions. |
|
Base classes for implementing extensions. |
|
Form definitions for extensions. |
|
Base support and implementations for extension hooks. |
|
Template loaders for extensions. |
|
Extension manager class for supporting extensions to an application. |
|
Middleware for extensions. |
|
Extension models. |
|
Packaging support for extensions. |
|
Settings API for extensions. |
|
Extension-related signals. |
|
Extension testing support. |
|
Mixins for test cases that need to test enabled extensions. |
|
URLs for extensions (used in the admin UI). |
|
Views for extensions (used in the admin UI). |
|
See also
Feature Checks¶
Feature switch support for applications. |
|
Classes for checking whether features are enabled for different criteria. |
|
Feature-related decorators. |
|
Error classes for features. |
|
Base support for defining a feature. |
|
Stability levels for a feature. |
|
Registry for managing feature registrations. |
|
Helpers for unit tests working with features. |
|
Template tags for working with features. |
See also
Feed View for RSS¶
Form Utilities¶
Additional fields for Django forms. |
|
Utilities related to django.contrib.admin fieldsets. |
|
Specialized forms provided by Djblets. |
|
A form for working with key/value stores. |
|
Custom widgets for Django form fields. |
Gravatars¶
Utilities for working with gravatars. |
|
Template tags for using gravatars. |
HTTP Utilities¶
Middleware for HTTP-related processing. |
Integrations¶
Exceptions for integrations. |
|
Forms for configuring integrations. |
|
Extension hooks for registering integrations. |
|
Base support for creating service integrations. |
|
A manager for tracking and working with integrations. |
|
Mixins for classes working with integrations. |
|
Database models for integration configuration. |
|
URL helpers for integrations. |
|
Views for working with integrations. |
See also
Log Handlers and Viewer¶
Logging support. |
|
Middleware used for logging. |
|
Siteconfig definitions for the log app. |
|
Views for the log app. |
Mail Sending¶
Functions for looking up DMARC entries in DNS. |
|
E-mail message composition and sending. |
|
Testing utilities for mail-related unit tests. |
|
General utility functions for working with e-mail. |
Markdown Utilities and Extensions¶
Markdown extension to safely escape HTML content. |
|
Markdown extension to render content similar to the source. |
|
Markdown extension to render content similar to the source in e-mails. |
Django Pipeline Additions¶
An ES6 Compiler which compiles .es6.js to .js. |
|
A LESS compiler which doesn't redirect the output. |
|
Utilities and constants for configuring Pipeline. |
Privacy Protection¶
Support for tracking and looking up user consent for privacy rights. |
|
Base support for consent types, data, and requirements. |
|
Common consent requirements for use in applications. |
|
Error classes for user consents. |
|
Forms, fields, and widgets for gathering and displaying consent. |
|
Extension hooks for consent requirements. |
|
Registry for things that require consent from a user. |
|
Consent tracking and storage capabilities. |
|
Database models for privacy-related data storage. |
|
Functions for safeguarding personally identifiable information. |
|
Privacy-related template tags. |
See also
reCAPTCHA¶
Mixins for providing reCAPTCHA validation support in forms. |
|
See also
Registries¶
Exception classes for dealing with Djblets registries. |
|
Import utilities for registries. |
|
Utility mixins for registries. |
|
Djblets registries. |
|
Signals for being notified on registry operations. |
See also
Secrets¶
Utilities for working with secrets and tokens. |
|
Encryption/decryption utilities. |
|
Token generators for creating access tokens. |
|
Base class for token generators. |
|
Token generator for legacy SHA1 tokens. |
|
Registry for token generators. |
|
Generator for tokens that contain an identifiable prefix and checksum. |
Site Configuration¶
Administration UI registrations for site configurations. |
|
Template context processors for SiteConfiguration information. |
|
Utilities for going between SiteConfiguration and Django settings. |
|
A base form for working with settings stored on SiteConfigurations. |
|
Model and cache management for SiteConfiguration. |
|
Middleware for managing site configurations. |
|
Database models for storing site configuration. |
|
Views for working with site configurations. |
Template Utilities¶
Utility functions for working with template-related caches. |
|
Utility functions for working with template contexts. |
|
Testing Helpers¶
Base class for test cases in Django-based applications. |
|
URL Utilities¶
URL patterns for applications that can use SITE_ROOT. |
|
Utility functions for looking up static media URLs. |
Generic Utilities¶
Compatibility for features removed in Python 3. |
|
Miscellaneous utilities. |
|
Utilities for working with dates. |
|
Miscellaneous, useful decorators. |
|
Filesystem-related utilities. |
|
HTML-related utilities. |
|
HTTP-related utilities. |
|
Functions to humanize values. |
|
Specialized descriptors/properties for classes. |
|
Utilities for serializing content. |
|
Common symbols useful for function signatures. |
|
Decorative template tags. |
|
E-mail formatting template tags. |
|
Form-related template tags. |
|
Image-related template tags. |
|
JavaScript-related template tags. |
|
Miscellaneous utility template tags. |
|
Common type definitions used for Djblets and consuming projects. |
|
View Helpers¶
Base classes and mixins for new class-based generic views. |
|
Mixin for class-based views that support ETags. |
Web API¶
Deprecated module for authentication-related functions and classes. |
|
Base support for managing API authentication backends. |
|
Authentication support for using API tokens. |
|
The base class for an API authentication backend. |
|
An authentication backend for HTTP Basic Auth. |
|
Web API support for OAuth2 authentication. |
|
Deprecated views for handling authentication. |
|
Decorators used for WebAPI views. |
|
Error classes and codes for WebAPI. |
|
Representations of field types in the API. |
|
Managers for API-related database models. |
|
OAuth2 scope generation for WebAPI resources. |
|
Deprecated module for Web API resource classes and registration. |
|
Base class for a resource in an API. |
|
Built-in resource representing the Group model. |
|
Resource registration and lookup. |
|
A flexible resource for the root of your API resource tree. |
|
Built-in resource representing the User model. |
|
Mixins for integrating token-based authentication into an API. |
|
Mixins for integrating a web API resource with a form. |
|
Web API resource support for OAuth2 token access. |
|
Mixins for helping with lookups from HTTP GET query strings. |
|
HTTP responses for Web APIs. |
|
Web API signals. |
|
Decorators to help with API test suites. |
|
Test case support for full API testing. |
See also