Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Ginger - DJ 5.5.3 documentation
Ginger - DJ 5.5.3 documentation
  • Ginger documentation
  • Getting started
    • Ginger at a glance
    • Quick install guide
    • Writing your first Ginger app, part 1
    • Writing your first Ginger app, part 2
    • Writing your first Ginger app, part 3
    • Writing your first Ginger app, part 4
    • Writing your first Ginger app, part 5
    • Writing your first Ginger app, part 6
    • Writing your first Ginger app, part 7
    • Writing your first Ginger app, part 8
    • Advanced tutorial: How to write reusable apps
    • What to read next
    • Writing your first patch for Ginger
  • Using Ginger
    • How to install Ginger
    • Models and databases
      • Models
      • Making queries
      • Aggregation
      • Search
      • Managers
      • Performing raw SQL queries
      • Database transactions
      • Multiple databases
      • Tablespaces
      • Database access optimization
      • Database instrumentation
      • Fixtures
      • Examples of model relationship API usage
        • Many-to-many relationships
        • Many-to-one relationships
        • One-to-one relationships
    • Handling HTTP requests
      • URL dispatcher
      • Writing views
      • View decorators
      • File Uploads
      • Ginger shortcut functions
      • Generic views
      • Middleware
      • How to use sessions
    • Working with forms
      • Formsets
      • Creating forms from models
      • Form Assets (the Media class)
    • Templates
    • Class-based views
      • Introduction to class-based views
      • Built-in class-based generic views
      • Form handling with class-based views
      • Using mixins with class-based views
    • Migrations
    • Managing files
    • Testing in Ginger
      • Writing and running tests
      • Testing tools
      • Advanced testing topics
    • Ginger’s cache framework
    • Conditional View Processing
    • Cryptographic signing
    • Sending email
    • Internationalization and localization
      • Translation
      • Format localization
      • Time zones
    • Logging
    • Pagination
    • Security in Ginger
    • Performance and optimization
    • Serializing Ginger objects
    • Ginger settings
    • Signals
    • System check framework
    • External packages
    • Asynchronous support
  • “How-to” guides
    • How to use Ginger’s CSRF protection
    • How to create custom ginger-admin commands
    • How to create custom model fields
    • How to write custom lookups
    • How to implement a custom template backend
    • How to create custom template tags and filters
    • How to write a custom storage class
    • How to deploy Ginger
      • How to deploy with WSGI
        • How to use Ginger with Gunicorn
        • How to use Ginger with uWSGI
        • How to use Ginger with Apache and mod_wsgi
      • How to deploy with ASGI
        • How to use Ginger with Daphne
        • How to use Ginger with Hypercorn
        • How to use Ginger with Uvicorn
      • Deployment checklist
    • How to upgrade Ginger to a newer version
    • How to manage error reporting
    • How to provide initial data for models
    • How to integrate Ginger with a legacy database
    • How to configure and use logging
    • How to create CSV output
    • How to create PDF files
    • How to override templates
    • How to manage static files (e.g. images, JavaScript, CSS)
    • How to deploy static files
    • How to install Ginger on Windows
    • How to create database migrations
    • How to delete a Ginger application
  • Ginger FAQ
    • FAQ: General
    • FAQ: Installation
    • FAQ: Using Ginger
    • FAQ: Getting Help
    • FAQ: Databases and models
    • FAQ: The admin
    • FAQ: Contributing code
    • Troubleshooting
  • API Reference
    • Applications
    • System check framework
    • Built-in class-based views API
      • Base views
      • Generic display views
      • Generic editing views
      • Generic date views
      • Class-based views mixins
        • Simple mixins
        • Single object mixins
        • Multiple object mixins
        • Editing mixins
        • Date-based mixins
      • Class-based generic views - flattened index
    • Clickjacking Protection
    • contrib packages
      • The Ginger admin site
        • Admin actions
        • ModelAdmin List Filters
        • The Ginger admin documentation generator
        • JavaScript customizations in the admin
      • The flatpages app
      • GeoGinger
        • GeoGinger Tutorial
        • GeoGinger Installation
          • Installing Geospatial libraries
          • Installing PostGIS
          • Installing SpatiaLite
        • GeoGinger Model API
        • GeoGinger Database API
        • GeoGinger Forms API
        • GIS QuerySet API Reference
        • Geographic Database Functions
        • Measurement Objects
        • GEOS API
        • GDAL API
        • Geolocation with GeoIP2
        • GeoGinger Utilities
          • LayerMapping data import utility
          • OGR Inspection
          • GeoJSON Serializer
        • GeoGinger Management Commands
        • GeoGinger’s admin site
        • Geographic Feeds
        • Geographic Sitemaps
        • Testing GeoGinger apps
        • Deploying GeoGinger
      • ginger.contrib.humanize
      • The messages framework
      • ginger.contrib.postgres
        • PostgreSQL specific aggregation functions
        • PostgreSQL specific database constraints
        • PostgreSQL specific query expressions
        • PostgreSQL specific model fields
        • PostgreSQL specific form fields and widgets
        • PostgreSQL specific database functions
        • PostgreSQL specific model indexes
        • PostgreSQL specific lookups
        • Database migration operations
        • Full text search
        • Validators
      • The redirects app
      • The sitemap framework
      • The “sites” framework
      • The staticfiles app
      • The syndication feed framework
    • Cross Site Request Forgery protection
    • Databases
    • ginger-admin and manage.py
    • Running management commands from your code
    • Ginger Exceptions
    • File handling
      • The File object
      • File storage API
      • Uploaded Files and Upload Handlers
    • Forms
      • The Forms API
      • Form fields
      • Model Form Functions
      • Formset Functions
      • The form rendering API
      • Widgets
      • Form and field validation
    • Logging
    • Middleware
    • Migration Operations
    • Models
      • Model field reference
      • Field attribute reference
      • Model index reference
      • Constraints reference
      • Model _meta API
      • Related objects reference
      • Model class reference
      • Model Meta options
      • Model instance reference
      • QuerySet API reference
      • Lookup API reference
      • Query Expressions
      • Conditional Expressions
      • Database Functions
    • Paginator
    • Request and response objects
    • SchemaEditor
    • Settings
    • Signals
    • Templates
      • The Ginger template language
      • Built-in template tags and filters
      • The Ginger template language: for Python programmers
    • TemplateResponse and SimpleTemplateResponse
    • Unicode data
    • ginger.urls utility functions
    • ginger.urls functions for use in URLconfs
    • ginger.conf.urls functions for use in URLconfs
    • Ginger Utils
    • Validators
    • Built-in Views
  • Meta-documentation and miscellany
    • API stability
    • Design philosophies
    • Third-party distributions of Ginger
  • Glossary
  • Ginger internals
    • Contributing to Ginger
      • An overview of the contributing process and what's involved.
      • Contributing code
        • Writing your first patch for Ginger
        • How to submit a patch to Ginger for new and/or fixed behavior
        • How to write and run tests
        • How to run Ginger's unit tests
        • How to work with Git and GitHub
        • Coding style
        • JavaScript code
        • Committing code
      • Writing documentation
      • Localizing Ginger
      • Reporting bugs and requesting features
      • Triaging tickets
    • Mailing lists and Forum
    • Organization of the Ginger Project
    • Ginger’s security policies
    • Ginger’s release process
    • The Ginger source code repository
Back to top

All modules for which code is available

  • ginger
    • ginger.apps.config
    • ginger.contrib.gis.measure
    • ginger.contrib.sessions.exceptions
    • ginger.core.exceptions
    • ginger.core.files.base
    • ginger.core.files.images
    • ginger.utils.encoding
    • ginger.utils.feedgenerator
    • ginger.utils.functional
    • ginger.utils.http
    • ginger.utils.module_loading
    • ginger.utils.safestring
Copyright © Ginger Society and contributors
Made with Sphinx and @pradyunsg's Furo
Last updated on Oct 22, 2024