Django documentation contents¶
- Getting started
- Django at a glance
- Quick install guide
- Writing your first Django app, part 1
- Writing your first Django app, part 2
- Writing your first Django app, part 3
- Writing your first Django app, part 4
- Writing your first Django app, part 5
- Writing your first Django app, part 6
- Writing your first Django app, part 7
- Advanced tutorial: How to write reusable apps
- What to read next
- Writing your first patch for Django
- Introduction
- Code of Conduct
- Installing Git
- Getting a copy of Django’s development version
- Running Django’s test suite for the first time
- Working on a feature
- Creating a branch for your patch
- Writing some tests for your ticket
- Writing the code for your ticket
- Running Django’s test suite for the second time
- Writing Documentation
- Previewing your changes
- Committing the changes in the patch
- Pushing the commit and making a pull request
- Next steps
- Using Django
- How to install Django
- Models and databases
- Handling HTTP requests
- Working with forms
- Templates
- Class-based views
- Migrations
- Managing files
- Testing in Django
- User authentication in Django
- Django’s cache framework
- Conditional View Processing
- Cryptographic signing
- Sending email
- Internationalization and localization
- Logging
- Pagination
- Security in Django
- Performance and optimization
- Serializing Django objects
- Django settings
- Signals
- System check framework
- External packages
- Asynchronous support
- “How-to” guides
- Authentication using
REMOTE_USER
- Writing custom
django-admin
commands - Writing custom model fields
- Custom Lookups
- Custom template backend
- Custom template tags and filters
- Writing a custom storage system
- Deploying Django
- Upgrading Django to a newer version
- Error reporting
- Providing initial data for models
- Integrating Django with a legacy database
- Outputting CSV with Django
- Outputting PDFs with Django
- Overriding templates
- Managing static files (e.g. images, JavaScript, CSS)
- Deploying static files
- How to install Django on Windows
- Writing database migrations
- Authentication using
- Django FAQ
- FAQ: General
- Why does this project exist?
- What does “Django” mean, and how do you pronounce it?
- Is Django stable?
- Does Django scale?
- Who’s behind this?
- How is Django licensed?
- Why does Django include Python’s license file?
- Which sites use Django?
- Django appears to be a MVC framework, but you call the Controller the “view”, and the View the “template”. How come you don’t use the standard names?
- <Framework X> does <feature Y> – why doesn’t Django?
- Why did you write all of Django from scratch, instead of using other Python libraries?
- Is Django a content-management-system (CMS)?
- How can I download the Django documentation to read it offline?
- How do I cite Django?
- FAQ: Installation
- FAQ: Using Django
- FAQ: Getting Help
- FAQ: Databases and models
- How can I see the raw SQL queries Django is running?
- Can I use Django with a pre-existing database?
- If I make changes to a model, how do I update the database?
- Do Django models support multiple-column primary keys?
- Does Django support NoSQL databases?
- How do I add database-specific options to my CREATE TABLE statements, such as specifying MyISAM as the table type?
- FAQ: The admin
- I can’t log in. When I enter a valid username and password, it just brings up the login page again, with no error messages.
- I can’t log in. When I enter a valid username and password, it brings up the login page again, with a “Please enter a correct username and password” error.
- How do I automatically set a field’s value to the user who last edited the object in the admin?
- How do I limit admin access so that objects can only be edited by the users who created them?
- My admin-site CSS and images showed up fine using the development server, but they’re not displaying when using mod_wsgi.
- My “list_filter” contains a ManyToManyField, but the filter doesn’t display.
- Some objects aren’t appearing in the admin.
- How can I customize the functionality of the admin interface?
- The dynamically-generated admin site is ugly! How can I change it?
- What browsers are supported for using the admin?
- FAQ: Contributing code
- How can I get started contributing code to Django?
- I submitted a bug fix in the ticket system several weeks ago. Why are you ignoring my patch?
- When and how might I remind the team of a patch I care about?
- But I’ve reminded you several times and you keep ignoring my patch!
- I’m sure my ticket is absolutely 100% perfect, can I mark it as “Ready For Checkin” myself?
- Troubleshooting
- FAQ: General
- API Reference
- Applications
- System check framework
- Built-in class-based views API
- Clickjacking Protection
contrib
packages- The Django admin site
django.contrib.auth
- The contenttypes framework
- The flatpages app
- GeoDjango
django.contrib.humanize
- The messages framework
django.contrib.postgres
- The redirects app
- The sitemap framework
- The “sites” framework
- The
staticfiles
app - The syndication feed framework
admin
auth
contenttypes
flatpages
gis
humanize
messages
postgres
redirects
sessions
sites
sitemaps
syndication
- Other add-ons
- Cross Site Request Forgery protection
- Databases
django-admin
andmanage.py
- Running management commands from your code
- Django Exceptions
- File handling
- Forms
- 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
TemplateResponse
andSimpleTemplateResponse
- Unicode data
django.urls
utility functionsdjango.urls
functions for use in URLconfsdjango.conf.urls
functions for use in URLconfs- Django Utils
- Validators
- Built-in Views
- Meta-documentation and miscellany
- Glossary
- Release notes
- Django internals