Source

django-dynamic-link / readme.html

  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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left{
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: left }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block {
  margin-left: 2em ;
  margin-right: 2em }

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<div class="section" id="description">
<h1>Description</h1>
<p>Django file streaming application to provide download links without showing the real path to the served file. The links can be set to expire by date or by clicks. It is also possible to use it for counting clicks on a download link.</p>
<p><strong>License</strong></p>
<blockquote>
New BSD license</blockquote>
<p><strong>Notes</strong></p>
<blockquote>
<ul class="simple">
<li>Tested with Django 1.2 / 1.3</li>
<li>Example project is included</li>
</ul>
</blockquote>
</div>
<div class="section" id="features">
<h1>Features</h1>
<blockquote>
<ul class="simple">
<li>Link expires by clicks (optional)</li>
<li>Link expires by time (optional)</li>
<li>Is usable for counting clicks</li>
</ul>
</blockquote>
</div>
<div class="section" id="installation">
<h1>Installation</h1>
<p><strong>Dependences</strong></p>
<blockquote>
<ul class="simple">
<li>This app</li>
<li>Django itself, its redirects from django.contrib and its locale middleware.</li>
</ul>
</blockquote>
<p><strong>Installation</strong></p>
<blockquote>
<p><em>Download &amp; installation with pip (recommended)</em></p>
<blockquote>
<p><em>Pip will download and install the package and take care of all the dependences.</em></p>
<ul>
<li><p class="first">Use the stable release (recommended)</p>
<blockquote>
<p>Type in your terminal:</p>
<pre class="literal-block">
:~$ pip install django-dynamic-link
</pre>
</blockquote>
</li>
<li><p class="first">Or the development version</p>
<blockquote>
<p>Than type in your terminal:</p>
<pre class="literal-block">
:~$ pip install -e hg+https://bitbucket.org/catapela/django-dynamic-link/#egg=django-dynamic-link
</pre>
</blockquote>
</li>
<li><p class="first">With pip you can also uninstall it:</p>
</li>
</ul>
<pre class="literal-block">
:~$ pip uninstall django-dynamic-link
</pre>
</blockquote>
<p><em>Manual Installation</em></p>
<blockquote>
<ul class="simple">
<li>To get the package from pypi (stable) or bitbucket (dev) see <a class="reference external" href="http://pypi.python.org/pypi/django-dynamic-link/#downloads">here</a>.</li>
</ul>
</blockquote>
</blockquote>
<blockquote>
<blockquote>
<ul class="simple">
<li>Download the file and unzip it.</li>
<li>Copy the folder in your project root.</li>
<li>Make shure all package dependences are fulfilled.</li>
</ul>
</blockquote>
<p><em>Other possibilities</em></p>
<blockquote>
<ul class="simple">
<li>Open a terminal and change to the folder which contains the setup.py and then type:</li>
</ul>
<pre class="literal-block">
:~$ python setup.py install
</pre>
</blockquote>
</blockquote>
<p><strong>test your installation</strong></p>
<blockquote>
<p>Go to console and type:</p>
<pre class="literal-block">
:~$ python
</pre>
<p>... than type:</p>
<pre class="doctest-block">
&gt;&gt;&gt; import dynamicLink
&gt;&gt;&gt; dynamicLink.VERSION
</pre>
</blockquote>
</div>
<div class="section" id="setup">
<h1>Setup</h1>
<blockquote>
<ul>
<li><p class="first">Add &quot;dynamicLink&quot; to you installed apps in the settings file.</p>
</li>
<li><dl class="first docutils">
<dt>Make sure that:</dt>
<dd><ol class="first last arabic simple">
<li>'django.middleware.locale.LocaleMiddleware', is in your MIDDLEWARE_CLASSES.</li>
<li>Your Admin is enabled ('django.contrib.admin', is in your INSTALLED_APPS).</li>
<li>'django.contrib.auth.context_processors.auth', (also for admin) is in TEMPLATE_CONTEXT_PROCESSORS.</li>
<li>'django.core.context_processors.request', is in TEMPLATE_CONTEXT_PROCESSORS.</li>
</ol>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add the following to your urls.py:</dt>
<dd><ol class="first last arabic simple">
<li>from dynamicLink import presettings</li>
<li>(r'^w+/%s/' % presettings.DYNAMIC_LINK_URL_BASE_COMPONENT, include('dynamicLink.urls')),</li>
</ol>
</dd>
</dl>
</li>
<li><p class="first">Finally run:</p>
</li>
</ul>
<pre class="literal-block">
:~$ python manage.py syncdb
:~$ python manage.py runserver
</pre>
</blockquote>
<p><strong>Make it custom</strong></p>
<blockquote>
<p>Use the global settings.py in your projects root to overwrite the applications presettings with the following variables.</p>
<ul>
<li><dl class="first docutils">
<dt>DYNAMIC_LINK_MEDIA</dt>
<dd><ul class="first last simple">
<li>Default: settings.MEDIA_ROOT</li>
<li>A path to a directory. From this point you can walk down the subdirectories to choose your files to serve.</li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>DYNAMIC_LINK_URL_BASE_COMPONENT</dt>
<dd><ul class="first last simple">
<li>Default: 'serve'</li>
<li>A string that modifies your url serve path.</li>
<li>Example: www.example.com/DYNAMIC_LINK_URL_BASE_COMPONENT/link/3839hd8HKl3/example.zip.</li>
</ul>
</dd>
</dl>
</li>
</ul>
</blockquote>
</div>
<div class="section" id="usage">
<h1>Usage</h1>
<p>Open the admin interface and go to &quot;Dynamiclink&quot; section. The rest should be self-explanatory.</p>
<p><strong>Hints</strong></p>
<blockquote>
<ul class="simple">
<li>Zero value for link age means never expires.</li>
<li>Zero value for clicks means unlimited clicks.</li>
<li>If a link never expires you can use it for click counting.</li>
<li>Trough the action menu you can serve a site with several links.</li>
<li>The filename from the created links are only for human readability. You can delete or change these filenames in any way you want.</li>
</ul>
</blockquote>
</div>
<div class="section" id="example-project">
<h1>Example project</h1>
<p>djang-dynamic-links ships with an example proect.</p>
<blockquote>
<ol class="arabic simple">
<li>Install the package (see install section).</li>
<li>Run &quot;python manage.py syncdb&quot; and &quot;python manage.py runserver&quot;.</li>
<li>Open a Browser, go to: <a class="reference external" href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a></li>
</ol>
</blockquote>
</div>
</div>
</body>
</html>