django-js-reverse 0.6.1

Javascript url handling for Django that doesn't hurt.
=================
Django JS Reverse
=================

.. image:: https://img.shields.io/pypi/v/django-js-reverse.svg
   :target: https://pypi.python.org/pypi/django-js-reverse/

.. image:: https://img.shields.io/travis/ierror/django-js-reverse/production.svg
   :target: https://travis-ci.org/ierror/django-js-reverse

.. image:: https://img.shields.io/coveralls/ierror/django-js-reverse/production.svg
   :alt: Coverage Status
   :target: https://coveralls.io/r/ierror/django-js-reverse?branch=production

.. image:: https://img.shields.io/github/license/ierror/django-js-reverse.svg
    :target: https://raw.githubusercontent.com/ierror/django-js-reverse/develop/LICENSE

.. image:: https://img.shields.io/pypi/dm/django-js-reverse.svg

.. image:: https://img.shields.io/pypi/wheel/django-js-reverse.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 <https://docs.djangoproject.com/en/dev/topics/http/urls/#naming-url-patterns>`_ 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.6.1
    Refactored: Separate the view functionality from the JS generation

    New: Replaced slimit by rjsmin based on `#33 <https://github.com/ierror/django-js-reverse/pull/33/>`_

    Thank you chripede

0.6.0
    Fix: `#27 <https://github.com/ierror/django-js-reverse/pull/27>`_

    Thank you michael-borisov

    New: Support for Keyword-based URL reversing `#30 <https://github.com/ierror/django-js-reverse/pull/30/>`_

    Thank you hyperair

0.5.1
    Fix: Current ply breaks slimit => force ply==3.4


`Full changelog <https://raw.githubusercontent.com/ierror/django-js-reverse/production/CHANGELOG>`_


Requirements
------------

-  Python (2.6, 2.7, 3.1, 3.3, 3.4, PyPy)
-  Django (1.5, 1.6, 1.7, 1.8)


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
_____________________

    {% 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)


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 :code:`this`

::

    JS_REVERSE_JS_GLOBAL_OBJECT_NAME = False


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 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/'


License
-------

`MIT <https://raw.github.com/ierror/django-js-reverse/develop/LICENSE>`_


Contact
-------

`@i_error <https://twitter.com/i_error>`_

--------------

Enjoy!
MIT

Author

Bernhard Janetzki

Pip

django-js-reverse==0.6.1

Classifiers

  • Development Status :: 5 - Production/Stable
  • Framework :: Django
  • License :: OSI Approved :: MIT License
  • Programming Language :: Python
  • Programming Language :: Python :: 3
  • Programming Language :: Python :: Implementation :: PyPy
File Type Python Version Uploaded On Downloads
django_js_reverse-0.6.1-py2.py3-none-any.whl Wheel 3.4 Aug. 8, 2015 377
django-js-reverse-0.6.1.tar.gz Source Aug. 8, 2015 220
Version Release Date
0.6.1 Aug. 8, 2015
0.6.0 Aug. 3, 2015
0.5.1 May 9, 2015
0.5.0 April 3, 2015
0.4.6 March 29, 2015
0.4.5 Feb. 28, 2015
0.4.4 Feb. 22, 2015
0.4.3 Feb. 22, 2015
0.4.2 Feb. 6, 2015
0.4.1 Aug. 26, 2015
0.4.0 Jan. 23, 2015
0.3.3 Sept. 3, 2014
0.3.2 Aug. 30, 2014
0.3.1 Aug. 24, 2014
0.3.0 Aug. 7, 2014
0.2.1 Aug. 21, 2013
0.2.0 March 27, 2013
0.1.1 March 24, 2013
0.1.0 Feb. 3, 2013
0.0.2 Feb. 2, 2013
0.0.1 Feb. 1, 2013
Date Package Version Action
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.4.6 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.5.1 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.4.5 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.4.2 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.4.3 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.4.0 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.4.1 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.3.3 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.2.1 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.1.0 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.4.4 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.0.1 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.6.0 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.6.1 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.5.0 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.3.2 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.0.2 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.2.0 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.3.1 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.3.0 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse 0.1.1 Release Created
Aug. 26, 2015, 12:14 a.m. django-js-reverse Package Created