Development Guide¶

This guide is for engineers who work on django-db-tenants itself, and for developers who integrate it and need to know how it behaves inside.

Map of the guide¶

Page	What you find there
Quick start	Clone, install, run the tests and the demo project in a few minutes
Local environment setup	Toolchain, database servers, environment files, IDE settings
Codebase structure	What each module and configuration file is for
Design overview	The five pieces that make multi-tenancy work, and the trade-offs the design accepts
Architecture	How a request, a task or a command reaches the right database
Model reference	The data model, with an editable diagram, and one page per model
CLI reference	Every management command and option
API reference	Settings, public functions and classes, module by module
Testing strategy	Test layout, fixtures, database backends, the tox matrix
Git workflow	Branches, commits and the pre-commit hooks
CI/CD and build	The checks a change must pass, building the package and the docs
Contribution guidelines	Code standards, extension recipes, release steps