conflicting template tag with django-debug-toolbar

[krisfields]

I get this error if I have both django-imagekit and django-debug-toolbar installed:

'compat' is not a valid tag library: Template library imagekit.templatetags.compat does not have a variable named 'register'

It looks like both django-imagekit and django-debug-toolbar have a templatetag file named compat.py.

Sorry about posting twice. I was logged in under someone else's account and didn't realize it.

[a1tus]

Ran into this issue too and had to disable debug-toolbar.

[krisfields]

I've determined that if I put debug-toolbar before django-imagekit in INSTALLED_APPS, the error goes away.

I think this should be ok since imagekit's compat doesn't actually seem to include any template tags - it's just being included by the imagekit templatetag file.

If you want to add debug-toolbar to INSTALLED_APPS in a local.py like I'm doing, you'll need to make sure it's added first instead of last, so something like this will work:
INSTALLED_APPS = ('debug_toolbar',) + INSTALLED_APPS

Or if you need to add it somewhere that is prior to imagekit, but not first, you could cast INSTALLED_APPS to a list, insert it where you wish, and cast it back to a tuple.

[matthewwithanm]

That makes total sense. If we move that file outside of the templatetags package, it should take care of it.

[dezoito]

Thank you, krisfields!

That fixed the issue for me too (after upgrading to Django 1.8).

[nex2hex]

same issue in django debug toolbar repo django-commons/django-debug-toolbar#734

[vstoykov]

In django-debug-toolbar ver. 1.4 this is fixed by renaming their templatetag library to debug_toolbar_compat.

As @matthewwithanm suggested we can move our compat module from templatetags package because it is not a templatetag library. Even if now the problem is fixed in dajngo-debug-toolbar we need to fix this to prevent future conflicts with other packages.

Because I'm not sure where will be the right place to move the compat module I think of renaming it _compat.

What you think about this guys?

[vstoykov]

I've made a Pull request with moving the compat module outside of templatetags package. I decided not to rename it with underscore but to move it in the main package.