Skip to main content

Javascript url handling for Django that doesn't hurt.

Project description Coverage Status

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: Support for Python 3.7
Fix: A bug fix in Django 2.0.6 has broken django-js-reverse #65 Thank you kavdev
Fix: The tests folder of the #53 was still present in the build. => Added cleanup to the release make command.

New: Support for Django 2.0: #58 Thank you wlonk

Fix: #53 - Don’t install the tests folder as a separate folder. Moved inside the django_js_reverse namespace.


New: Support for Django 1.10

Chg: Renamed “production” branch to “master”

Fix: #48 - “Change False to ‘window’ in global object name in README.” Thank you karamanolev

Fix: PR #45 - “Fix: collectstatic_js_reverse usage message” Thank you ghedsouza

Fix: PR #44 - “Remove duplicate _get_url call” Thank you razh

Full changelog


Python version Django versions
3.7 2.0, 1.11, 1.10, 1.9, 1.8
3.6 2.0, 1.11, 1.10, 1.9, 1.8
3.5 2.0, 1.11, 1.10, 1.9, 1.8
3.4 2.0, 1.11, 1.10, 1.9, 1.8, 1.7, 1.6, 1.5
2.7 1.11, 1.10, 1.9, 1.8, 1.7, 1.6, 1.5


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 with webpack

Install using npm

npm install --save django-js-reverse

Include none-cached view …

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

… or a cached one that delivers the urls JSON

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

Include JavaScript in your bundle:

// utils/djangoReverse.mjs
import _ from 'lodash/fp';
import djangoJsReverse from 'django-js-reverse';

export default _.once(
  async () => {
    const res = await fetch('/jsreverse.json');
    const data = await res.json():
    return djangoJsReverse(data);
// somePlace.mjs
import djangoReverse from './utils/djangoReverse';

(async () => {
  const urls = await djangoReverse;
  const url = urls.someViewName('some-arg');

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)

You can also pass javascript objects to match keyword aguments like the examples bellow:

Urls['betterliving-get-house']({ category_slug: 'house', entry_pk: 12 })
Urls['namespace:betterliving-get-house']({ category_slug: 'house', entry_pk: 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 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 tips: * Use “” (empty string) for urls without namespace * Use “foo0” 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






Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_js_reverse_webpack-0.0.1-py2.py3-none-any.whl (20.2 kB) Copy SHA256 hash SHA256 Wheel py2.py3
django-js-reverse-webpack-0.0.1.tar.gz (19.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page