Install

pip install autobreadcrumbs
  1. In your settings file add autobreadcrumbs to your installed apps:

    INSTALLED_APPS = (
        ...
        'autobreadcrumbs',
        ...
    )
    
  2. Import default settings:

    from autobreadcrumbs.settings import *
    
  3. Register its context processor:

    TEMPLATE_CONTEXT_PROCESSORS = (
        ...
        'autobreadcrumbs.context_processors.AutoBreadcrumbsContext',
        ...
    )
    

    (Order with other context processors don’t matter).

  4. Finally add these two lines in your main urls.py:

    import autobreadcrumbs
    autobreadcrumbs.autodiscover()
    

    This is optional but if you don’t do this, all crumbs.py file will be ignored and only titles defined in settings.AUTOBREADCRUMBS_TITLES will be used.