ierror/django-js-reverse


Javascript url handling for Django that doesn't hurt.

License: MIT

Language: Python

Keywords: django, python, urls


Django JS Reverse

Coverage Status

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

New: Support for Python 3.7

New: Support for Django 2.2

New: Unit Tests Script prefix with no slash, changed URL Conf`#72 <https://github.com/ierror/django-js-reverse/issues/72>`__ Thank you graingert

Fix: "ROOT_URLCONF not taken into account" #73 #74 Thank you LuukOost and graingert

Refactoring: "move template logic to view" #64 Thank you graingert

Fix: "Now using LooseVersion instead of StrictVersion to avoid issues with rc releases" #67 Thank you kavdev

0.8.2
Fix: A bug fix in Django 2.0.6 has broken django-js-reverse #65 Thank you kavdev
0.8.1
Fix: The tests folder of the #53 was still present in the build. => Added cleanup to the release make command.
0.8.0

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.

Full changelog

Requirements

Python version Django versions
3.7 2.2, 2.1, 2.0, 1.11, 1.10, 1.9, 1.8
3.6 2.2, 2.1, 2.0, 1.11, 1.10, 1.9, 1.8
3.5 2.2, 2.1, 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

Installation

Install using pip

pip install django-js-reverse

… or clone the project from github.

git clone https://github.com/ierror/django-js-reverse.git

Add 'django_js_reverse' to your INSTALLED_APPS setting.

INSTALLED_APPS = (
    ...
    'django_js_reverse',
)

Usage as static file

First generate static file by

./manage.py 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

You can place the js_reverse JavaScript inline into your templates, however use of inline JavaScript is not recommended, because it will make it impossible to deploy a secure Content Security Policy. See django-csp

{% load js_reverse %}

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

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 })

Options

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

JS_REVERSE_JS_VAR_NAME = 'Urls'

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

JS_REVERSE_JS_GLOBAL_OBJECT_NAME = 'window'

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

JS_REVERSE_JS_MINIFY = False

By default all namespaces are included

JS_REVERSE_EXCLUDE_NAMESPACES = []

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:

JS_REVERSE_SCRIPT_PREFIX = '/myprefix/'

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

JS_REVERSE_OUTPUT_PATH = 'some_path'

Running the test suite

tox

License

MIT

Contact

@i_error


Enjoy!

Project Statistics

Sourcerank 10
Repository Size 259 KB
Stars 462
Forks 72
Watchers 16
Open issues 12
Dependencies 15
Contributors 25
Tags 31
Created
Last updated
Last pushed

Top Contributors See all

Bernhard Thomas Grainger Chow Loong Jin Filip Dobrovolný Niels Lemmens Mohammad Javad Naderi aumo Yuri Prezument Alexander Kavanaugh Michael Borisov Christian Pedersen Eric Palakovich Carr Krupin Dmitry LuukOost Justin Walgran Aron Jones Karol Kozikowski Paul Kit La Touche Ivailo Karamanolev

Packages Referencing this Repo

django-js-reverse
JavaScript url handling for Django that doesn't hurt.
Latest release 0.10.1-a.0 - Updated - 462 stars
django-js-reverse-webpack
Javascript url handling for Django that doesn't hurt.
Latest release 0.0.1 - Updated - 462 stars
django-js-reverse
Javascript url handling for Django that doesn't hurt.
Latest release 0.10.1a0 - Updated - 462 stars

Recent Tags See all

0.10.1a0 August 02, 2019
0.10.0 August 01, 2019
v0.9.1 May 09, 2019
v0.9.0 May 05, 2019
v0.8.2 July 08, 2018
v0.8.1 December 17, 2017
v0.8.0 December 17, 2017
v0.7.3 December 19, 2016
v0.7.2 May 19, 2016
v0.7.1 April 15, 2016
v0.7.0 March 06, 2016
v0.6.1 August 08, 2015
v0.6.0 August 03, 2015
v0.5.1 May 09, 2015
v0.5.0 April 03, 2015

Interesting Forks See all

BrnoPCmaniak/django-js-reverse
Javascript url handling for Django that doesn't hurt.
Python - MIT - Last pushed - 1 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-08-02 11:10:17 UTC

Login to resync this repository