skip to navigation
skip to content

django-js-reverse 0.7.3

Javascript url handling for Django that doesn't hurt.

Django JS Reverse

.. image::

.. image::

.. image::
:alt: Coverage Status

.. image::

.. 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 <https:"" en="" dev="" topics="" http="" urls="" #naming-url-patterns="">`_ 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: Support for Django 1.10

Chg: Renamed "production" branch to "master"

Fix: `#48 <https:"" ierror="" django-js-reverse="" issues="" 48="">`_ - "Change False to 'window' in global object name in README."
Thank you `karamanolev <https:"" karamanolev="">`_

Fix: `PR #45 <https:"" ierror="" django-js-reverse="" pull="" 45="">`_ - "Fix: collectstatic_js_reverse usage message"
Thank you `ghedsouza <https:"" ghedsouza="">`_

Fix: `PR #44 <https:"" ierror="" django-js-reverse="" pull="" 44="">`_ - "Remove duplicate _get_url call"
Thank you `razh <https:"" razh="">`_

Fix: `#42 <https:"" ierror="" django-js-reverse="" issues="" 42="">`_ - "Templatetag js_reverse_inline breaks on Django 1.9"
Thank you `tommikaikkonen <https:"" tommikaikkonen="">`_

Optimized imports

Fix: `#41 <https:"" ierror="" django-js-reverse="" issues="" 41="">`_ - make it possible to use number 0 as url argument

`Full changelog <https:"" ierror="" django-js-reverse="" master="" changelog="">`_


- Python (2.6, 2.7, 3.1, 3.3, 3.4, 3.5)
- Django (1.5, 1.6, 1.7, 1.8, 1.9, 1.10)


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>

Usage as template tag

{% load js_reverse %}

<script type="text/javascript" charset="utf-8">
{% js_reverse_inline %}

Use the urls in javascript

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)


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



Optionally, you can change the name of the global object the javascript variable
used to access the named urls is attached to. Default is :code:`this`



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 you want to include only specific namespaces add them to the `JS_REVERSE_INCLUDE_ONLY_NAMESPACES` setting
* Use "" for urls without namespace
* Use "foo\0" to include urls just from "foo" namaspace and not from any subnamespaces (e.g. "foo:bar")


JS_REVERSE_INCLUDE_ONLY_NAMESPACES = ['poll', 'calendar', ...]

If you run your application under a subpath, the collectstatic_js_reverse needs to take care of this.
Define the prefix in your django settings:

By default collectstatic_js_reverse writes its output (reverse.js) to your project's STATIC_ROOT.
You can change the output path:



Running the test suite


make test


`MIT <https:"" ierror="" django-js-reverse="" develop="" license="">`_


`@i_error <https:"" i_error="">`_


File Type Py Version Uploaded on Size
django-js-reverse-0.7.3.tar.gz (md5, pgp) Source 2016-12-19 16KB
django_js_reverse-0.7.3-py2.py3-none-any.whl (md5, pgp) Python Wheel 3.4 2016-12-19 21KB