Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

Javascript url handling for Django that doesn't hurt.
https://github.com/ierror/django-js-reverse

django python urls

Last synced: 24 days ago
JSON representation

Javascript url handling for Django that doesn't hurt.

Awesome Lists containing this project

README 

        
=================

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/master.svg

   :target: https://travis-ci.org/ierror/django-js-reverse



.. image:: https://img.shields.io/coveralls/ierror/django-js-reverse/master.svg

   :alt: Coverage Status

   :target: https://coveralls.io/r/ierror/django-js-reverse?branch=master



.. image:: https://img.shields.io/github/license/ierror/django-js-reverse.svg

    :target: https://raw.githubusercontent.com/ierror/django-js-reverse/master/LICENSE



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



**Javascript url handling for Django that doesn’t hurt.**



|

|



=============================================================================================================

📣 This package is now maintained by `Vinta Software https://github.com/vintasoftware/django-js-reverse` 📣

=============================================================================================================



|

|



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[-\w]+)/(?P\d+)/$', 'get_house', name='betterliving_get_house'),



in javascript like:



::



    Urls.betterlivingGetHouse('house', 12)



Result:



::



    /betterliving/house/12/



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



::



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



::



    



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



::



    



or, if you are using Django > 1.5



::



    



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



    

        {% 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.betterlivingGetHouse('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 :code:`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 "foo\0" 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!