Reference¶
Use this section to look up supported interfaces and configuration. For a complete install-to-application sequence, start with First project: a ticket desk.
Find a contract¶
| You need to look up… | Reference |
|---|---|
| Configuration fields, environment variables and precedence | Settings |
| ViewSets, serializers, permissions and actions | API |
| Models, fields, queries and managers | ORM |
| Command arguments, flags and parser defaults | CLI |
| Exception families and HTTP error handling | Exceptions |
| Type aliases and their import paths | Types |
| Supported Python, PostgreSQL and web dependencies | Runtime compatibility |
The settings and CLI references expose declarations from the implementation. A parser default does not establish the effects of running a command. Use the linked workflows for prerequisites, database setup and operational checks. The API and ORM pages describe selected public contracts; they are not a catalog of every internal class or method.
Choose guidance by task¶
- Create and run an application: follow the first project, or the template-specific setup when using
startproject. - Understand data access: read models, queries and transactions.
- Protect an endpoint: start with authentication and permissions; check the custom-action boundary before adding an action.
- Operate a deployment: use the production guide, Doctor and upgrade guide.
For terminology and maturity, see the glossary and stability guide. A successful import alone does not make an internal or experimental interface stable.
Check the installed version¶
Use the changelog and release stability contracts to understand the installed version's supported surface. The local package can differ from the version used to build the documentation.