Skip to main content

Javascript url handling for Django that doesn't hurt.

Project description

https://badge.fury.io/py/django-js-reverse.png https://travis-ci.org/ierror/django-js-reverse.png Coverage Status https://pypip.in/license/django-js-reverse/badge.svg

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.3

New: Django 1.7 support

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, 1.7)

Installation

Install using pip

pip install django-js-reverse

… or clone the project from github.

git clone git@github.com: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!

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.3.3.tar.gz (5.7 kB view details)

Uploaded Source

File details

Details for the file django-js-reverse-0.3.3.tar.gz.

File metadata

File hashes

Hashes for django-js-reverse-0.3.3.tar.gz
Algorithm Hash digest
SHA256 c0079ab778bcfe3879909e91e40d27b5f7454c3c44aafdec9ea15907c0f72802
MD5 0edb5e6ac40f35a8afa6d1efbdacba24
BLAKE2b-256 e2ee8d9476f2234ce6a66c38e075d99d7346baf173a164eda60dcc176a61bf28

See more details on using hashes here.

Provenance

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