django-coverage /

Filename Size Date modified Message
177 B
466 B
304 B
11.1 KB
461 B
353 B
2.4 KB
1.6 KB

Django Test Coverage App

What is it?

A test coverage reporting tool that utilizes Ned Batchelder's excellent to show how much of your code is exercised with your tests.


  • Django 1.2 and above. For earlier versions, try version 1.0.3 of django-coverage.

How do I use it?

Install as a Django app

  1. Place the entire django_coverage app in your third-party apps directory.
  2. Update your settings.INSTALLED_APPS to include django_coverage.
  3. Include test coverage specific settings in your own settings file. See for more detail.

Once you've completed all the steps, you'll have a new custom command available to you via test_coverage. It works just like test.

Use it as a test runner

You don't have to install django_coverage as an app if you don't want to. You can simply use the test runner if you like.

  1. Update settings.TEST_RUNNER = 'django_coverage.coverage_runner.CoverageRunner'
  2. Include test coverage specific settings in your own settings file. See for more detail.
  3. Run test like you normally do.


Coverage badges

django_coverage will also generate a badge image that represents the percentage coverage that your project has.

This will be stored in the same directory as the coverage report data: $PROJECT/.coverage/coverage_status.png.

Currently, the only badge type that is included is When other types are included, you will be able to select which is used by settings.COVERAGE_BADGE_TYPE.

To prevent the badge generation, you could set this to None.

Using the coverage badge with has no native support for coverage reporting. However, you can save build artifacts: just tell it to save one called: .coverage/coverage_status.png. Then you can reference it in your project's README.

And that's it.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.