django-js-reverse 0.3.2

Javascript url handling for Django that doesn't hurt.

Javascript url handling for Django that doesn’t hurt.

Overview

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:

urls.py:

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)

Result:

/betterliving/house/12/

Changelog

0.3.2

New: Default minification of the generated javascript file

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

Testing: Use selenium for better testing

0.3.1

Added support for namespaces

0.3.0

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”

Requirements

• Python (2.6, 2.7, 3.1, 3.3, 3.4, PyPy)

• Django (1.4, 1.5, 1.6)

Installation

Install using pip …

pip install django-js-reverse

… or clone the project from github.

git clone [e-mail]:ierror/django-js-reverse.git

Add 'django_js_reverse' to your INSTALLED_APPS setting.

INSTALLED_APPS = (
    ...
    'django_js_reverse',
)

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>

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

JS_REVERSE_JS_VAR_NAME = 'Urls'

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

JS_REVERSE_JS_MINIFY = False

Usage

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)

License

MIT

Contact

@i_error

---

Enjoy!