Coverage for django_image_tools/__init__ : 24 | 100% 25 |
26 |
27 |
22 |
36 |
37 |
23 |
27 |
35 |
27 |
38 | 
39 |
59 |
60 |
39 | Hot-keys on this page
40 |
41 |
58 | 42 | r 43 | m 44 | x 45 | p toggle line displays 46 |
47 |48 | j 49 | k next/prev highlighted chunk 50 |
51 |52 | 0 (zero) top of page 53 |
54 |55 | 1 (one) first highlighted chunk 56 |
57 |
61 |
62 |
71 |
72 |
73 |
80 |
81 |
82 |
83 |
--------------------------------------------------------------------------------
/docs/build/html/genindex.html:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
8 |
9 |
10 | | 64 | 65 | | 66 |67 | 68 | | 69 |
41 |
78 |
87 |
91 |
92 |
--------------------------------------------------------------------------------
/docs/build/html/_static/css/badge_only.css:
--------------------------------------------------------------------------------
1 | .fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#FontAwesome") format("svg")}.fa:before{display:inline-block;font-family:FontAwesome;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .fa{display:inline-block;text-decoration:inherit}li .fa{display:inline-block}li .fa-large:before,li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.fas li .fa{width:0.8em}ul.fas li .fa-large:before,ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before{content:"\f02d"}.icon-book:before{content:"\f02d"}.fa-caret-down:before{content:"\f0d7"}.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before{content:"\f0d8"}.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before{content:"\f0d9"}.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before{content:"\f0da"}.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book{float:left}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge .fa-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book{float:left}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}}
2 |
--------------------------------------------------------------------------------
/htmlcov/django_image_tools_tests___init__.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
42 |
56 |
76 |
77 |
43 |
55 |
44 |
45 |
46 |
54 | Index
47 | 48 |
49 |
50 |
51 |
52 |
53 |
22 |
36 |
37 |
23 |
27 |
35 | Coverage for django_image_tools/tests/__init__ : 24 | 100% 25 |
26 |
27 | 28 | 1 statements 29 | 30 | 31 | 32 | 33 |
34 |
38 |
39 |
59 |
60 |
39 | Hot-keys on this page
40 |
41 |
58 | 42 | r 43 | m 44 | x 45 | p toggle line displays 46 |
47 |48 | j 49 | k next/prev highlighted chunk 50 |
51 |52 | 0 (zero) top of page 53 |
54 |55 | 1 (one) first highlighted chunk 56 |
57 |
61 |
62 |
73 |
74 |
75 |
82 |
83 |
84 |
85 |
--------------------------------------------------------------------------------
/htmlcov/jquery.hotkeys.js:
--------------------------------------------------------------------------------
1 | /*
2 | * jQuery Hotkeys Plugin
3 | * Copyright 2010, John Resig
4 | * Dual licensed under the MIT or GPL Version 2 licenses.
5 | *
6 | * Based upon the plugin by Tzury Bar Yochay:
7 | * http://github.com/tzuryby/hotkeys
8 | *
9 | * Original idea by:
10 | * Binny V A, http://www.openjs.com/scripts/events/keyboard_shortcuts/
11 | */
12 |
13 | (function(jQuery){
14 |
15 | jQuery.hotkeys = {
16 | version: "0.8",
17 |
18 | specialKeys: {
19 | 8: "backspace", 9: "tab", 13: "return", 16: "shift", 17: "ctrl", 18: "alt", 19: "pause",
20 | 20: "capslock", 27: "esc", 32: "space", 33: "pageup", 34: "pagedown", 35: "end", 36: "home",
21 | 37: "left", 38: "up", 39: "right", 40: "down", 45: "insert", 46: "del",
22 | 96: "0", 97: "1", 98: "2", 99: "3", 100: "4", 101: "5", 102: "6", 103: "7",
23 | 104: "8", 105: "9", 106: "*", 107: "+", 109: "-", 110: ".", 111 : "/",
24 | 112: "f1", 113: "f2", 114: "f3", 115: "f4", 116: "f5", 117: "f6", 118: "f7", 119: "f8",
25 | 120: "f9", 121: "f10", 122: "f11", 123: "f12", 144: "numlock", 145: "scroll", 191: "/", 224: "meta"
26 | },
27 |
28 | shiftNums: {
29 | "`": "~", "1": "!", "2": "@", "3": "#", "4": "$", "5": "%", "6": "^", "7": "&",
30 | "8": "*", "9": "(", "0": ")", "-": "_", "=": "+", ";": ": ", "'": "\"", ",": "<",
31 | ".": ">", "/": "?", "\\": "|"
32 | }
33 | };
34 |
35 | function keyHandler( handleObj ) {
36 | // Only care when a possible input has been specified
37 | if ( typeof handleObj.data !== "string" ) {
38 | return;
39 | }
40 |
41 | var origHandler = handleObj.handler,
42 | keys = handleObj.data.toLowerCase().split(" ");
43 |
44 | handleObj.handler = function( event ) {
45 | // Don't fire in text-accepting inputs that we didn't directly bind to
46 | if ( this !== event.target && (/textarea|select/i.test( event.target.nodeName ) ||
47 | event.target.type === "text") ) {
48 | return;
49 | }
50 |
51 | // Keypress represents characters, not special keys
52 | var special = event.type !== "keypress" && jQuery.hotkeys.specialKeys[ event.which ],
53 | character = String.fromCharCode( event.which ).toLowerCase(),
54 | key, modif = "", possible = {};
55 |
56 | // check combinations (alt|ctrl|shift+anything)
57 | if ( event.altKey && special !== "alt" ) {
58 | modif += "alt+";
59 | }
60 |
61 | if ( event.ctrlKey && special !== "ctrl" ) {
62 | modif += "ctrl+";
63 | }
64 |
65 | // TODO: Need to make sure this works consistently across platforms
66 | if ( event.metaKey && !event.ctrlKey && special !== "meta" ) {
67 | modif += "meta+";
68 | }
69 |
70 | if ( event.shiftKey && special !== "shift" ) {
71 | modif += "shift+";
72 | }
73 |
74 | if ( special ) {
75 | possible[ modif + special ] = true;
76 |
77 | } else {
78 | possible[ modif + character ] = true;
79 | possible[ modif + jQuery.hotkeys.shiftNums[ character ] ] = true;
80 |
81 | // "$" can be triggered as "Shift+4" or "Shift+$" or just "$"
82 | if ( modif === "shift+" ) {
83 | possible[ jQuery.hotkeys.shiftNums[ character ] ] = true;
84 | }
85 | }
86 |
87 | for ( var i = 0, l = keys.length; i < l; i++ ) {
88 | if ( possible[ keys[i] ] ) {
89 | return origHandler.apply( this, arguments );
90 | }
91 | }
92 | };
93 | }
94 |
95 | jQuery.each([ "keydown", "keyup", "keypress" ], function() {
96 | jQuery.event.special[ this ] = { add: keyHandler };
97 | });
98 |
99 | })( jQuery );
100 |
--------------------------------------------------------------------------------
/docs/build/html/search.html:
--------------------------------------------------------------------------------
1 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | | 64 | 65 | 66 | | 67 |68 | 69 | 70 | | 71 |
48 |
85 |
94 |
98 |
99 |
--------------------------------------------------------------------------------
/django_image_tools/settings.py:
--------------------------------------------------------------------------------
1 | # Created by Bonsai Studio
49 |
79 |
83 |
84 |
50 |
78 |
51 |
52 |
77 | Search
53 |
54 |
55 |
60 | 56 | Please activate JavaScript to enable the search 57 | functionality. 58 |
59 |61 | From here you can search these documents. Enter your search 62 | words into the box below and click "search". Note that the search 63 | function will automatically search for all of the words. Pages 64 | containing fewer words won't appear in the result list. 65 |
66 | 71 | 72 |
73 |
74 |
75 |
76 |
48 |
97 |
112 |
116 |
117 |
--------------------------------------------------------------------------------
/docs/source/quickstart.rst:
--------------------------------------------------------------------------------
1 | Quick Start
2 | ===========
3 |
4 | All you have to do is
5 |
6 | ::
7 |
8 | pip install django-image-tools-2
9 |
10 | and of course, add the app in your INSTALLED_APPS as
11 |
12 | ::
13 |
14 | INSTALLED_APPS = (
15 | ...
16 | 'django_image_tools',
17 | ...
18 | )
19 |
20 | Configuration
21 | -------------
22 |
23 | The minimum required settings you should add in your settings.py are:
24 |
25 | ::
26 |
27 | # Folder in which you want to store your images, in this example it's the sub folder 'media'
28 | MEDIA_ROOT = os.path.join(PROJECT_ROOT, 'media')
29 | # Temporary folder for upload, in this example is the subfolder 'upload'
30 | UPLOAD_TO = os.path.join(PROJECT_ROOT, 'media/upload')
31 |
32 | The folders will be created if they do not exist.
33 |
34 | You should also add your filters and sizes in your settings file, like this:
35 |
36 | ::
37 |
38 | DJANGO_IMAGE_TOOLS_SIZES = {
39 | 'thumbnail': {
40 | 'width': 30,
41 | 'height': 30,
42 | 'auto': None
43 | },
44 | 'very_long': {
45 | 'width': 200,
46 | 'height': 30,
47 | 'auto': None
48 | },
49 | 'very_tall': {
50 | 'width': 30,
51 | 'height': 200,
52 | 'auto': None
53 | },
54 | 'huge': {
55 | 'width': 2000,
56 | 'height': 2000,
57 | 'auto': None
58 | },
59 | 'auto_width': {
60 | 'width': 0,
61 | 'height': 20,
62 | 'auto': 'WIDTH'
63 | },
64 | 'auto_height': {
65 | 'width': 20,
66 | 'height': 0,
67 | 'auto': 'HEIGHT'
68 | },
69 | }
70 |
71 | DJANGO_IMAGE_TOOLS_FILTERS = {
72 | 'grey_scaled': {
73 | 'filter_type': 'GREYSCALE'
74 | },
75 | 'blurred': {
76 | 'filter_type': 'GAUSSIAN_BLUR',
77 | 'value': 5
78 | }
79 | }
80 |
81 |
82 | That's it, you're good to go now.
83 | Let's create a couple of models containing images!
84 |
85 |
86 | Example models
87 | --------------
88 |
89 | Let's say you have a "Person" model and you want to include an Avatar, or a profile pic. Here's how you do it
90 |
91 | ::
92 |
93 | ....
94 | from django_image_tools.models import Image
95 |
96 | class Person(models.Model):
97 |
98 | first_name = models.CharField(max_length=255)
99 | second_name = models.CharField(max_length=255)
100 | ...
101 |
102 | picture = models.ForeignKey(Image)
103 |
104 |
105 |
106 | You can also (obviously) use a ManyToMany field, for example:
107 |
108 | ::
109 |
110 | ....
111 | from django_image_tools.models import Image
112 |
113 | class Slideshow(models.Model):
114 | title = models.CharField(max_length=255)
115 | description = models.TextField()
116 | ...
117 |
118 | slides = models.ManyToManyField(Image)
119 |
120 |
121 |
122 | That's all you need to do when dealing with the models.
123 |
124 | Then, in your templates, you can use them like this:
125 |
126 | ::
127 |
128 | # Displaying a thumbnail
129 |
49 |
67 |
95 |
96 |
50 |
66 |
51 |
52 |
65 |
53 |
62 |
63 |
64 | How it works¶
54 |The app only creates the image the first time it is requested. So don’t worry about the system clogging 55 | because you have 10.0000 images and you create a new size on the fly, or having your server filled up with cached 56 | images that are never used. 57 | The images are also cached, so you should never experience a notable lag, unless you request a bunch of images 58 | of a size that was never processed. 59 | The app uses an md5 checksum to check if the image was changed. This way, it can detect even if the image was 60 | replaced by some other app, (or the user) and reprocess the various sizes of that image on request.
61 |
56 |
57 | How intuitive is that?
58 | Note that filters and sizes are separated by a double '_', as django-esque as possible.
59 |
60 | Obviously, you cannot add filters / sizes whose name contains a double '_'.
61 |
62 |
63 | Size & Cropping
64 | ---------------
65 |
66 | You will find in the admin panel the 'django_image_tools' option. You can enter all the sizes
67 | you're going to use in your website there.
68 | The options for each size are:
69 |
70 | - Name
71 | - Width (auto)
72 | - Height (auto)
73 |
74 | All of the sizes you create will be available for the images the user will upload through its name.
75 | For example, you can have a 'thumbnail' 250x250 size, and every image you upload will have the ``get__thumbnail``
76 | method that will output the path for the image with the requested size.
77 |
78 | Having 'auto' height, for exmaple, means that the image will be resized to match the given width, and keep the original
79 | aspect ratio (This is useful for example, if you want to create a *pinterest* board).
80 |
81 | Of course, you can only have auto height or auto width, but not both.
82 |
83 | In the template, to display an image field, all you have to do is:
84 |
85 | ::
86 |
87 |
48 |
106 |
121 |
125 |
126 |
--------------------------------------------------------------------------------
/htmlcov/style.css:
--------------------------------------------------------------------------------
1 | /* CSS styles for Coverage. */
2 | /* Page-wide styles */
3 | html, body, h1, h2, h3, p, td, th {
4 | margin: 0;
5 | padding: 0;
6 | border: 0;
7 | outline: 0;
8 | font-weight: inherit;
9 | font-style: inherit;
10 | font-size: 100%;
11 | font-family: inherit;
12 | vertical-align: baseline;
13 | }
14 |
15 | /* Set baseline grid to 16 pt. */
16 | body {
17 | font-family: georgia, serif;
18 | font-size: 1em;
19 | }
20 |
21 | html>body {
22 | font-size: 16px;
23 | }
24 |
25 | /* Set base font size to 12/16 */
26 | p {
27 | font-size: .75em; /* 12/16 */
28 | line-height: 1.33333333em; /* 16/12 */
29 | }
30 |
31 | table {
32 | border-collapse: collapse;
33 | }
34 |
35 | a.nav {
36 | text-decoration: none;
37 | color: inherit;
38 | }
39 | a.nav:hover {
40 | text-decoration: underline;
41 | color: inherit;
42 | }
43 |
44 | /* Page structure */
45 | #header {
46 | background: #f8f8f8;
47 | width: 100%;
48 | border-bottom: 1px solid #eee;
49 | }
50 |
51 | #source {
52 | padding: 1em;
53 | font-family: "courier new", monospace;
54 | }
55 |
56 | #indexfile #footer {
57 | margin: 1em 3em;
58 | }
59 |
60 | #pyfile #footer {
61 | margin: 1em 1em;
62 | }
63 |
64 | #footer .content {
65 | padding: 0;
66 | font-size: 85%;
67 | font-family: verdana, sans-serif;
68 | color: #666666;
69 | font-style: italic;
70 | }
71 |
72 | #index {
73 | margin: 1em 0 0 3em;
74 | }
75 |
76 | /* Header styles */
77 | #header .content {
78 | padding: 1em 3em;
79 | }
80 |
81 | h1 {
82 | font-size: 1.25em;
83 | }
84 |
85 | h2.stats {
86 | margin-top: .5em;
87 | font-size: 1em;
88 | }
89 | .stats span {
90 | border: 1px solid;
91 | padding: .1em .25em;
92 | margin: 0 .1em;
93 | cursor: pointer;
94 | border-color: #999 #ccc #ccc #999;
95 | }
96 | .stats span.hide_run, .stats span.hide_exc,
97 | .stats span.hide_mis, .stats span.hide_par,
98 | .stats span.par.hide_run.hide_par {
99 | border-color: #ccc #999 #999 #ccc;
100 | }
101 | .stats span.par.hide_run {
102 | border-color: #999 #ccc #ccc #999;
103 | }
104 |
105 | .stats span.run {
106 | background: #ddffdd;
107 | }
108 | .stats span.exc {
109 | background: #eeeeee;
110 | }
111 | .stats span.mis {
112 | background: #ffdddd;
113 | }
114 | .stats span.hide_run {
115 | background: #eeffee;
116 | }
117 | .stats span.hide_exc {
118 | background: #f5f5f5;
119 | }
120 | .stats span.hide_mis {
121 | background: #ffeeee;
122 | }
123 | .stats span.par {
124 | background: #ffffaa;
125 | }
126 | .stats span.hide_par {
127 | background: #ffffcc;
128 | }
129 |
130 | /* Help panel */
131 | #keyboard_icon {
132 | float: right;
133 | cursor: pointer;
134 | }
135 |
136 | .help_panel {
137 | position: absolute;
138 | background: #ffc;
139 | padding: .5em;
140 | border: 1px solid #883;
141 | display: none;
142 | }
143 |
144 | #indexfile .help_panel {
145 | width: 20em; height: 4em;
146 | }
147 |
148 | #pyfile .help_panel {
149 | width: 16em; height: 8em;
150 | }
151 |
152 | .help_panel .legend {
153 | font-style: italic;
154 | margin-bottom: 1em;
155 | }
156 |
157 | #panel_icon {
158 | float: right;
159 | cursor: pointer;
160 | }
161 |
162 | .keyhelp {
163 | margin: .75em;
164 | }
165 |
166 | .keyhelp .key {
167 | border: 1px solid black;
168 | border-color: #888 #333 #333 #888;
169 | padding: .1em .35em;
170 | font-family: monospace;
171 | font-weight: bold;
172 | background: #eee;
173 | }
174 |
175 | /* Source file styles */
176 | .linenos p {
177 | text-align: right;
178 | margin: 0;
179 | padding: 0 .5em;
180 | color: #999999;
181 | font-family: verdana, sans-serif;
182 | font-size: .625em; /* 10/16 */
183 | line-height: 1.6em; /* 16/10 */
184 | }
185 | .linenos p.highlight {
186 | background: #ffdd00;
187 | }
188 | .linenos p a {
189 | text-decoration: none;
190 | color: #999999;
191 | }
192 | .linenos p a:hover {
193 | text-decoration: underline;
194 | color: #999999;
195 | }
196 |
197 | td.text {
198 | width: 100%;
199 | }
200 | .text p {
201 | margin: 0;
202 | padding: 0 0 0 .5em;
203 | border-left: 2px solid #ffffff;
204 | white-space: nowrap;
205 | }
206 |
207 | .text p.mis {
208 | background: #ffdddd;
209 | border-left: 2px solid #ff0000;
210 | }
211 | .text p.run, .text p.run.hide_par {
212 | background: #ddffdd;
213 | border-left: 2px solid #00ff00;
214 | }
215 | .text p.exc {
216 | background: #eeeeee;
217 | border-left: 2px solid #808080;
218 | }
219 | .text p.par, .text p.par.hide_run {
220 | background: #ffffaa;
221 | border-left: 2px solid #eeee99;
222 | }
223 | .text p.hide_run, .text p.hide_exc, .text p.hide_mis, .text p.hide_par,
224 | .text p.hide_run.hide_par {
225 | background: inherit;
226 | }
227 |
228 | .text span.annotate {
229 | font-family: georgia;
230 | font-style: italic;
231 | color: #666;
232 | float: right;
233 | padding-right: .5em;
234 | }
235 | .text p.hide_par span.annotate {
236 | display: none;
237 | }
238 |
239 | /* Syntax coloring */
240 | .text .com {
241 | color: green;
242 | font-style: italic;
243 | line-height: 1px;
244 | }
245 | .text .key {
246 | font-weight: bold;
247 | line-height: 1px;
248 | }
249 | .text .str {
250 | color: #000080;
251 | }
252 |
253 | /* index styles */
254 | #index td, #index th {
255 | text-align: right;
256 | width: 5em;
257 | padding: .25em .5em;
258 | border-bottom: 1px solid #eee;
259 | }
260 | #index th {
261 | font-style: italic;
262 | color: #333;
263 | border-bottom: 1px solid #ccc;
264 | cursor: pointer;
265 | }
266 | #index th:hover {
267 | background: #eee;
268 | border-bottom: 1px solid #999;
269 | }
270 | #index td.left, #index th.left {
271 | padding-left: 0;
272 | }
273 | #index td.right, #index th.right {
274 | padding-right: 0;
275 | }
276 | #index th.headerSortDown, #index th.headerSortUp {
277 | border-bottom: 1px solid #000;
278 | }
279 | #index td.name, #index th.name {
280 | text-align: left;
281 | width: auto;
282 | }
283 | #index td.name a {
284 | text-decoration: none;
285 | color: #000;
286 | }
287 | #index td.name a:hover {
288 | text-decoration: underline;
289 | color: #000;
290 | }
291 | #index tr.total {
292 | }
293 | #index tr.total td {
294 | font-weight: bold;
295 | border-top: 1px solid #ccc;
296 | border-bottom: none;
297 | }
298 | #index tr.file:hover {
299 | background: #eeeeee;
300 | }
301 |
--------------------------------------------------------------------------------
/docs/source/how_to_use.rst:
--------------------------------------------------------------------------------
1 | How to use it
2 | =============
3 |
4 | Philosophy
5 | ----------
6 |
7 | There are many tools suitable for cutting, cropping, resizing and applying filters at runtime.
8 | but we noticed that many of these lacked a sense of 'DRY-ness'
9 | as almost all of them forced you to input the size and the filter options in the template itself.
10 |
11 | Now, try to see this from a designer point of view. As a designer, I want all of the images in this template to have a
12 | specific effect, and maybe I want a different effect for the hover version. So what do I do? Do I write down the
13 | effect's parameters for each image in the template?
14 |
15 | And what if I wanted to change the effect after the template is ready?
16 |
17 | The same thing applies for image sizes, what if you suddenly needed your images to be bigger or smaller?
18 |
19 | Django Image Tools allows you to create specific filters and sizes for your images, and bind those filters to
20 | your images through their name, so you can change the filter parameters and the image size from your settings file,
21 | and those changes will automatically be applied to all of the bound images in your templates. Now your templates
22 | will remain untouched even if you decide to change a filter, or even the size of your images.
23 |
24 | We believe this will save some time looking at the docs of an app trying to figure out which custom filter file you
25 | should include, how to input your parameters, etc...
26 |
27 |
28 | Include it in your models
29 | -------------------------
30 |
31 | Nothing more simple. Just import the 'Image' model in your models.py file and create a Foreign Key to it. Done!
32 |
33 | Syntax
34 | ------
35 |
36 | We tried to make the syntax as readable and intuitive as possible.
37 | Filter names should be applied before size names. Size names are mandatory.
38 |
39 | To activate django_image_tools, you need to call a ``get__`` attribute on the image.
40 |
41 | For example, if you want the path for a size named 'thumbnail', you should define a new Size called 'thumbnail' on
42 | your settings file. Then, in your templates you should use:
43 |
44 | ::
45 |
46 |
49 |
76 |
104 |
105 |
50 |
75 |
51 |
52 |
74 |
53 |
71 |
72 |
73 | More features¶
54 |The images will all be available in the admin panel. You can browse and search through all of them. 55 | Sometimes, the users will upload a ‘small’ image (You know users right?) and then they’ll complain that the image 56 | doesn’t scale well, or it’s too jpegged. 57 | The app will automatically flag all images for which an upscaled version was requested, by flagging them with the 58 | ‘was_upscaled’ flag (if you’re using django_suit, the background of the row will also be displayed red). You can use the filter in the app to see which one were upscaled, and delete them, or replace them with a higher-res version. 59 | The original images will never be touched, unless the user wants to rename them. 60 | The cached image folder can be changed in the system settings, through the settings variable 61 | ‘DJANGO_IMAGE_TOOLS_CACHE_DIR’. This will always be a sub dir of the ‘MEDIA’ dir, though I might change this 62 | in the future. 63 | I strongly advice you to use the ‘raw_id_fields’ for the image fields, as it will allow the user to search for a 64 | previously submitted image or input a new one with a nice popup menu. This will decrease the number of duplicates. 65 | I also strongly advice you to remove permission for non admin users for the ‘size’ app, as removing a size that is 66 | used inside a template will result (obviously) in a 500 error. 67 | If there is a ‘thumbnail’ size, the app will display images of that size for the admin panel, otherwise it will fall 68 | back on the original. 69 | You can fetch the original image path by requesting ‘image.get__original’.
70 |
47 |
48 | To improve readability of your templates, we advice you to name the filters as adjectives.
49 | For example, a Gaussian Blur could be called 'blurred'.
50 |
51 | If you want to have a thumbnail with your Gaussian blur, now the template reads:
52 |
53 | ::
54 |
55 |
56 |
57 | How intuitive is that?
58 | Note that filters and sizes are separated by a double '_', as django-esque as possible.
59 |
60 | Obviously, you cannot add filters / sizes whose name contains a double '_'.
61 |
62 |
63 | Size & Cropping
64 | ---------------
65 |
66 | Sizes and filters are defined in your settings file. Previous versions of this app had them defined into the admin
67 | panel, but we soon discovered how this was a real pain, especially when trying to work on multiple environments.
68 |
69 | Here is a simple settings definition:
70 |
71 | ```
72 |
73 | DJANGO_IMAGE_TOOLS_SIZES = {
74 | 'thumbnail': {
75 | 'width': 30,
76 | 'height': 30,
77 | 'auto': None
78 | },
79 | 'very_long': {
80 | 'width': 200,
81 | 'height': 30,
82 | 'auto': None
83 | },
84 | 'very_tall': {
85 | 'width': 30,
86 | 'height': 200,
87 | 'auto': None
88 | },
89 | 'huge': {
90 | 'width': 2000,
91 | 'height': 2000,
92 | 'auto': None
93 | },
94 | 'auto_width': {
95 | 'width': 0,
96 | 'height': 20,
97 | 'auto': 'WIDTH'
98 | },
99 | 'auto_height': {
100 | 'width': 20,
101 | 'height': 0,
102 | 'auto': 'HEIGHT'
103 | },
104 | }
105 |
106 | ```
107 |
108 | All of the sizes you create will be available for the images the user will upload through their name.
109 | For example, you can have a 'thumbnail' 250x250 size, and every image you upload will have the ``get__thumbnail``
110 | method that will output the path for the image with the requested size.
111 |
112 | Having 'auto' height, for exmaple, means that the image will be resized to match the given width, and keep the original
113 | aspect ratio (This is useful for example, if you want to create a *pinterest* board).
114 | The 'auto' attribute can be either None (or just not defined), 'WIDTH', or 'HEIGHT'.
115 |
116 | In the template, to display an image field, all you have to do is:
117 |
118 | ::
119 |
120 |
44 |
128 |
140 |
144 |
145 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line.
5 | SPHINXOPTS =
6 | SPHINXBUILD = sphinx-build
7 | PAPER =
8 | BUILDDIR = build
9 |
10 | # User-friendly check for sphinx-build
11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13 | endif
14 |
15 | # Internal variables.
16 | PAPEROPT_a4 = -D latex_paper_size=a4
17 | PAPEROPT_letter = -D latex_paper_size=letter
18 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19 | # the i18n builder cannot share the environment and doctrees with the others
20 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21 |
22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23 |
24 | help:
25 | @echo "Please use \`make
45 |
95 |
126 |
127 |
46 |
94 |
47 |
48 |
93 |
49 | 
51 | 
52 | 
53 | 
54 | 
55 | 
56 |
82 | Welcome to Django Image Tools’s documentation!¶
50 |
51 |
52 |
53 |
54 |
55 |
56 | Contents:
57 |
58 |
81 | -
59 |
- Quick Start
-
60 |
- Configuration 61 |
- Example models 62 |
- Including thumbnails in your admin 63 |
65 | - How to use it
-
66 |
- Philosophy 67 |
- Include it in your models 68 |
- Syntax 69 |
- Size & Cropping 70 |
- Filters 71 |
73 | - How it works 74 |
- More features 75 |
- Testing
-
76 |
- Support 77 |
79 |
83 |
90 |
91 |
92 | Indices and tables¶
84 |-
85 |
- Index 86 |
- Module Index 87 |
- Search Page 88 |
' + _('Hide Search Matches') + '
') 181 | .appendTo($('#searchbox')); 182 | } 183 | }, 184 | 185 | /** 186 | * init the domain index toggle buttons 187 | */ 188 | initIndexTable : function() { 189 | var togglers = $('img.toggler').click(function() { 190 | var src = $(this).attr('src'); 191 | var idnum = $(this).attr('id').substr(7); 192 | $('tr.cg-' + idnum).toggle(); 193 | if (src.substr(-9) == 'minus.png') 194 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 195 | else 196 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 197 | }).css('display', ''); 198 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 199 | togglers.click(); 200 | } 201 | }, 202 | 203 | /** 204 | * helper function to hide the search marks again 205 | */ 206 | hideSearchWords : function() { 207 | $('#searchbox .highlight-link').fadeOut(300); 208 | $('span.highlighted').removeClass('highlighted'); 209 | }, 210 | 211 | /** 212 | * make the url absolute 213 | */ 214 | makeURL : function(relativeURL) { 215 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 216 | }, 217 | 218 | /** 219 | * get the current relative url 220 | */ 221 | getCurrentURL : function() { 222 | var path = document.location.pathname; 223 | var parts = path.split(/\//); 224 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 225 | if (this == '..') 226 | parts.pop(); 227 | }); 228 | var url = parts.join('/'); 229 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 230 | } 231 | }; 232 | 233 | // quick alias for translations 234 | _ = Documentation.gettext; 235 | 236 | $(document).ready(function() { 237 | Documentation.init(); 238 | }); 239 | -------------------------------------------------------------------------------- /docs/build/html/testing.html: -------------------------------------------------------------------------------- 1 | 3 | 4 | 5 | 6 | 7 | 8 | 9 |
44 |
129 |
141 |
145 |
146 |
--------------------------------------------------------------------------------
/docs/source/conf.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | #
3 | # Django Image Tools documentation build configuration file, created by
4 | # sphinx-quickstart on Fri May 30 10:34:36 2014.
5 | #
6 | # This file is execfile()d with the current directory set to its
7 | # containing dir.
8 | #
9 | # Note that not all possible configuration values are present in this
10 | # autogenerated file.
11 | #
12 | # All configuration values have a default; values that are commented out
13 | # serve to show the default.
14 |
15 | import sys
16 | import os
17 |
18 | # If extensions (or modules to document with autodoc) are in another directory,
19 | # add these directories to sys.path here. If the directory is relative to the
20 | # documentation root, use os.path.abspath to make it absolute, like shown here.
21 | #sys.path.insert(0, os.path.abspath('.'))
22 |
23 | # -- General configuration ------------------------------------------------
24 |
25 | # If your documentation needs a minimal Sphinx version, state it here.
26 | #needs_sphinx = '1.0'
27 |
28 | # Add any Sphinx extension module names here, as strings. They can be
29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30 | # ones.
31 | extensions = []
32 |
33 | # Add any paths that contain templates here, relative to this directory.
34 | templates_path = ['_templates']
35 |
36 | # The suffix of source filenames.
37 | source_suffix = '.rst'
38 |
39 | # The encoding of source files.
40 | #source_encoding = 'utf-8-sig'
41 |
42 | # The master toctree document.
43 | master_doc = 'index'
44 |
45 | # General information about the project.
46 | project = u'Django Image Tools'
47 | copyright = u'2014, Bonsai Studio'
48 |
49 | # The version info for the project you're documenting, acts as replacement for
50 | # |version| and |release|, also used in various other places throughout the
51 | # built documents.
52 | #
53 | # The short X.Y version.
54 | version = '0.7.b1'
55 | # The full version, including alpha/beta/rc tags.
56 | release = '0.7.b1'
57 |
58 | # The language for content autogenerated by Sphinx. Refer to documentation
59 | # for a list of supported languages.
60 | #language = None
61 |
62 | # There are two options for replacing |today|: either, you set today to some
63 | # non-false value, then it is used:
64 | #today = ''
65 | # Else, today_fmt is used as the format for a strftime call.
66 | #today_fmt = '%B %d, %Y'
67 |
68 | # List of patterns, relative to source directory, that match files and
69 | # directories to ignore when looking for source files.
70 | exclude_patterns = []
71 |
72 | # The reST default role (used for this markup: `text`) to use for all
73 | # documents.
74 | #default_role = None
75 |
76 | # If true, '()' will be appended to :func: etc. cross-reference text.
77 | #add_function_parentheses = True
78 |
79 | # If true, the current module name will be prepended to all description
80 | # unit titles (such as .. function::).
81 | #add_module_names = True
82 |
83 | # If true, sectionauthor and moduleauthor directives will be shown in the
84 | # output. They are ignored by default.
85 | #show_authors = False
86 |
87 | # The name of the Pygments (syntax highlighting) style to use.
88 | pygments_style = 'sphinx'
89 |
90 | # A list of ignored prefixes for module index sorting.
91 | #modindex_common_prefix = []
92 |
93 | # If true, keep warnings as "system message" paragraphs in the built documents.
94 | #keep_warnings = False
95 |
96 |
97 | # -- Options for HTML output ----------------------------------------------
98 |
99 | # The theme to use for HTML and HTML Help pages. See the documentation for
100 | # a list of builtin themes.
101 | html_theme = 'default'
102 |
103 | # Theme options are theme-specific and customize the look and feel of a theme
104 | # further. For a list of options available for each theme, see the
105 | # documentation.
106 | #html_theme_options = {}
107 |
108 | # Add any paths that contain custom themes here, relative to this directory.
109 | #html_theme_path = []
110 |
111 | # The name for this set of Sphinx documents. If None, it defaults to
112 | # "
45 |
94 |
127 |
128 |
46 |
93 |
47 |
48 |
92 |
49 |
56 |
57 |
61 |
62 |
67 |
68 |
82 |
83 |
89 |
90 |
91 | Testing¶
50 |Often times you will find yourself having images required in your models, and testing these models can be a real pain in the 51 | donkey as you will have to create images just for that.
52 |We want to make things simple for you, so you can import our method ‘create_dummy_image’ to easily create a dummy image for your tests!
53 |create_dummy_image(filename=u'Test_image', title=u'Title', caption=u'Caption', alt_text=u'Alt Text',
54 | credit=u'Credit'):
55 | This will create a new dummy entry in the database, so all you have to do is to assign it to your model’s Foreign Key.
58 |Remember to call
59 |image.delete()
60 | In your tearDown.
63 |Also, django_image_tools will never delete your images, so you will have to delete them yourself. 64 | Just kidding, we made a script for that too.
65 |delete_image(image)
66 | So, here’s a complete script.
69 |def setUp(self):
70 | partnerImage = create_dummy_image()
71 | model_with_image = Model(name=u'Coca cola', image=partnerImage)
72 | partner.save()
73 |
74 | def testInsert(self):
75 | self.assertEqual(Model.objects.all()[0].name, 'Coca cola')
76 |
77 | def tearDown(self):
78 | model_with_image = Model.objects.all()[0]
79 | delete_image(model_with_image.image)
80 | model_with_image.delete()
81 |
84 |
88 | Support¶
85 |Django Image Tools uses Travis CI to test the integration with several versions of Python and Django. 86 | You can see the list of currently supported combinations on our Travis CI page.
87 |