File: PKG-INFO

package info (click to toggle)
django-js-reverse 0.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 212 kB
  • sloc: python: 838; makefile: 5
file content (288 lines) | stat: -rw-r--r-- 8,972 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
Metadata-Version: 1.1
Name: django-js-reverse
Version: 0.7.3
Summary: Javascript url handling for Django that doesn't hurt.
Home-page: https://github.com/ierror/django-js-reverse
Author: Bernhard Janetzki
Author-email: boerni@gmail.com
License: MIT
Download-URL: http://pypi.python.org/pypi/django-js-reverse/
Description: =================
        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/develop/LICENSE
        
        .. 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.7.3
            New: Support for Django 1.10
        
            Chg: Renamed "production" branch to "master"
        
            Fix: `#48 <https://github.com/ierror/django-js-reverse/issues/48>`_ - "Change False to 'window' in global object name in README."
            Thank you `karamanolev <https://github.com/karamanolev>`_
        
            Fix: `PR #45 <https://github.com/ierror/django-js-reverse/pull/45>`_ - "Fix: collectstatic_js_reverse usage message"
            Thank you `ghedsouza <https://github.com/ghedsouza>`_
        
            Fix: `PR #44 <https://github.com/ierror/django-js-reverse/pull/44>`_ - "Remove duplicate _get_url call"
            Thank you `razh <https://github.com/razh>`_
        
        0.7.2
            Fix: `#42 <https://github.com/ierror/django-js-reverse/issues/42>`_ - "Templatetag js_reverse_inline breaks on Django 1.9"
            Thank you `tommikaikkonen <https://github.com/tommikaikkonen>`_
        
            Optimized imports
        
        0.7.1
            Fix: `#41 <https://github.com/ierror/django-js-reverse/issues/41>`_ - make it possible to use number 0 as url argument
        
        
        `Full changelog <https://raw.githubusercontent.com/ierror/django-js-reverse/master/CHANGELOG>`_
        
        
        Requirements
        ------------
        
        -  Python (2.6, 2.7, 3.1, 3.3, 3.4, 3.5)
        -  Django (1.5, 1.6, 1.7, 1.8, 1.9, 1.10)
        
        
        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 = '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 "" 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
        ----------------------
        
        ::
        
            make test
        
        License
        -------
        
        `MIT <https://raw.github.com/ierror/django-js-reverse/develop/LICENSE>`_
        
        
        Contact
        -------
        
        `@i_error <https://twitter.com/i_error>`_
        
        --------------
        
        Enjoy!
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Framework :: Django
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License