Skip to main content

Javascript url handling for Django that doesn't hurt.

Project description

Django JS Reverse
.. image::

.. image::

.. image::
:alt: Coverage Status

.. image::

**Javascript url handling for Django that doesn’t hurt.**


Django JS Reverse is a small django app that makes url handling of
`named urls`_ in javascript easy and non-annoying..

For example you can retrieve a named url:


url(r'^/betterliving/(?P<category_slug>[-\w]+)/(?P<entry_pk>\d+)/$', 'get_house', name='betterliving_get_house'),

in javascript like:


Urls.betterliving_get_house('house', 12)




New: Add better support for django rest framework
Django rest framework generates url names like user-list, so it get's converted now as well so
Urls['user-list']() or the cleaner Urls.user_list() are both usable.

Fix: JSReverseStaticFileSaveTest is working and being tested again

Improvement: Cleanup Javascript

Thank you bulv1ne for the pull request

New: Test support for the latest pypy versions pypy3-2.4.0 and pypy-2.5.0

Fix: Get rid of test warning "MIDDLEWARE_CLASSES is not set." for Django >= 1.7

Provided PyPI wheel Package

Fix: collectstatic runner: moved to own management command collectstatic_js_reverse

Add ability to save in file
<script src="{% static 'django_js_reverse/js/reverse.js' %}"></script>
to do this run ./ collectstatic

to exclude namespaces from import
default is []

To exclude e.g. admin and Django Debug Toolbar:

Thank you Andertaker

New: Support for nested namespaces. Thank you hyperair

New: Support for arguments within namespace path. Thank you hyperair

New: Support for optional url arguments. Thank you hyperair

New: Django 1.7 support

New: Default minification of the generated javascript file

Fix: content type of the jsreverse script. Thank you @emcsween

Testing: Use selenium for better testing

Added support for namespaces

Test support for pypy, python 3.4, django 1.6

Refactored include of JS_REVERSE_JS_VAR_NAME js var name

Get rid of "DeprecationWarning: The mimetype keyword argument is depracated, use content_type instead"


- Python (2.6, 2.7, 3.1, 3.3, 3.4, PyPy)
- Django (1.4, 1.5, 1.6, 1.7)


Install using ``pip`` …


pip install django-js-reverse

… or clone the project from github.


git clone

Add ``'django_js_reverse'`` to your ``INSTALLED_APPS`` setting.



Usage as static file

First generate static file by
./ collectstatic_js_reverse

If you change some urls or add an app and want to update the reverse.js file,
run the command again.

After this add the file to your template
<script src="{% static 'django_js_reverse/js/reverse.js' %}"></script>

Usage with views

Include none-cached view …


urlpatterns = patterns('',
url(r'^jsreverse/$', 'django_js_reverse.views.urls_js', name='js_reverse'),

… or a cached one that delivers the urls javascript


from django_js_reverse.views import urls_js
urlpatterns = patterns('',
url(r'^jsreverse/$', cache_page(3600)(urls_js), name='js_reverse'),

Include javascript in your template


<script src="{% url js_reverse %}" type="text/javascript"></script>

or, if you are using Django > 1.5


<script src="{% url 'js_reverse' %}" type="text/javascript"></script>


Optionally, you can overwrite the default javascript variable ‘Urls’ used
to access the named urls by django setting



Optionally, you can disable the minfication of the generated javascript file
by django setting



By default all namespaces are included



To exclude any namespaces from the generated javascript file, add them to the `JS_REVERSE_EXCLUDE_NAMESPACES` setting


JS_REVERSE_EXCLUDE_NAMESPACES = ['admin', 'djdt', ...]


If your url names are valid javascript identifiers ([$A-Z\_][-Z\_$]\*)i
you can access them by the Dot notation:


Urls.betterliving_get_house('house', 12)

If the named url contains invalid identifiers use the Square bracket
notation instead:


Urls['betterliving-get-house']('house', 12)
Urls['namespace:betterliving-get-house']('house', 12)




`@i_error <>`_



.. _named urls:
.. _MIT:

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-js-reverse-0.4.3.tar.gz (7.8 kB view hashes)

Uploaded Source

Built Distribution

django_js_reverse-0.4.3-py2.py3-none-any.whl (9.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page