Skip to content

Installation

Requirements

  • Python 3.10+
  • Django 4.2+
  • Docker (running locally or in CI)

Basic Installation

uv add django-testcontainers-plus

pip install django-testcontainers-plus

PostgreSQL support is included by default - no extras needed.

Optional Extras

Some providers require additional client libraries. Install them with the appropriate extra:

pip install django-testcontainers-plus[mysql]

pip install django-testcontainers-plus[redis]

pip install django-testcontainers-plus[all]

Why are extras needed?

PostgreSQL works without extras because the base testcontainers package includes PostgreSQL support. MySQL and Redis require their respective Python client libraries (mysql-connector-python and redis).

Verify Docker is Available

Django Testcontainers Plus requires Docker to be running. Verify with:

docker ps

If Docker isn't running, start it before running your tests.

CI Environments

Most CI providers (GitHub Actions, GitLab CI, CircleCI) include Docker by default. Make sure your CI job has Docker available and installs all required extras:

pip install django-testcontainers-plus[all]

See Troubleshooting for common CI issues.