Getting Started


  1. Install django-badger. Currently there’s no released version, so you need to install it from git:

    pip install -e
  2. (Optional) Install django-notification.

  3. Configure django-badger. See Configuration.

  4. Add settings to your Django settings file. See the Configuration section.

  5. (Optional) Add files to your Django apps. FIXME - need docs for this.

  6. Set up string extraction so that django-badger strings are translated.

See for an example site setup.



String. The prefix for template files. Default is “badger”.

For example, if the value is “foo”, then the django-badger home view renders the template “foo/home.html”.


Dict. Specifies the issuer of the badges. Example:

    'origin': SITE_URL,
    'name': 'Name of my site',
    'org': 'Name of my org',
    'contact': '',

Defaults to:

    'origin': '',
    'name': 'Badger',
    'org': 'Mozilla',
    'contact': ''
Boolean. Master switch for wide-open badge creation by all users. This is also known as “multiplayer mode”.
Integer. Page size for badge listings. Default is 50.
Integer. Number of items shown on home page recent sections. Default is 15.
Tuple of (Integer, Integer). Specifies the maximum height and width for badge images. Defaults to (256, 256).

See for an example site setup

See badger_example/ in the source code for another example.

Setting up views and/or using the API

See Views for documentation on the views that come with django-badger and how to use them.

See API for documentation on the django-badger API.