Running the Test Suite

The easiest way to run the django-filter tests is to check out the source code and create a virtualenv where you can install the test dependencies. Django-filter uses a custom test runner to configure the environment, so a wrapper script is available to set up and run the test suite.


The following assumes you have virtualenv and git installed.

Clone the repository

Get the source code using the following command:

$ git clone

Switch to the django-filter directory:

$ cd django-filter

Set up the virtualenv

Create a new virtualenv to run the test suite in:

$ virtualenv venv

Then activate the virtualenv and install the test requirements:

$ source venv/bin/activate
$ pip install -r requirements/test.txt

Execute the test runner

Run the tests with the runner script:

$ python

Test all supported versions

You can also use the excellent tox testing tool to run the tests against all supported versions of Python and Django. Install tox, and then simply run:

$ pip install tox
$ tox


The isort utility is used to maintain module imports. You can either test the module imports with the appropriate tox env, or with isort directly.

$ pip install tox
$ tox -e isort

# or

$ pip install isort
$ isort --check-only --recursive django_filters tests

To sort the imports, simply remove the --check-only option.

$ isort --recursive django_filters tests