1 This file documents the contents of this module
3 Last update 4 sept. 2013
5 See the devel/ subdir for more devel-oriented doc.
7 ==================== 1 minute howto
9 * REQUIREMENTS is to have python + django (1.5.2) installed django
10 ** should be straightforward
11 ** see devel/django-install.txt in case of trouble
13 * git clone git://git.onelab.eu/myslice.git
15 * git clone ssh://yourlogin@git.onelab.eu/git/myslice.git
17 * edit myslice/config.py and enter the details of your manifold backend
24 $ ./manage.py collectstatic (formerly, we used make static, which is deprecated)
26 $ ./manage.py collectstatic --noinput
30 $ manage.py runserver 0.0.0.0:8000
32 $ devel/server-loop.sh
33 when you just need to hit ^C yourself when your static files need to be refreshed - see below
35 * use it from your browser
36 (See more notes on using the development server below)
38 * install dependencies
39 $ pip install -r path/to/requirements/file.txt
40 Note. not quite sure what this is about, I could not spot this file..
42 ==================== Status
44 *** Authentication ***
47 Not quite sure if/how the user gets proper notifications when
48 . his session has expired (i.e. his frontend is not logged into the backend any longer)
49 . his credentials have expired (i.e. the uploaded credentials, e.g. SFA delegated cred)
50 expired and she needs to run e.g. sfi myslice again
52 Hard-coded accounts (from a very early stage) are gone
57 I've done a very rough attempt at packaging for rpm.
58 The logic seems about right but needs more work, in particular in terms of installing myslice.conf
59 in the httpd conf.d directory.
60 It seems like our app won't work on f14 as is because Django is only 1.3.1 on f14
61 Plan is to target f18 but I lack a test machine.
62 Also of course I'll try to tackle debian/ubunti at some point.
64 There also is a working packaging for debian(s) and ubuntu(s) that we use
65 on an almost daily basis to upgrade manifold.pl.sophia.inria.fr
70 Third party tools shipped:
77 Others are added as we build the system when they become needed
78 Look in third-party/ for a more detailed list
80 As a rule of thumb, please try to keep in mind that these will need to
81 be upgraded over time I've tried to keep track of the version I picked
82 and to have an easy upgrade path (depending on the way the original
85 ==================== Contents: 1st level subdirs
87 ========== code from git
90 this is the django 'project', where to look for
95 the code for dealing with queries, sending them to the backend, and offering the /manifold/proxy/ URL
98 the code for building / rendering plugins
101 the actual code for plugins
104 a django 'app' that deals with authentication; see especially
105 auth.backend.MyCustomBackend
106 for how to use a separate authentication system,
107 as well as settings.py for how to enable it
110 this is where the first implementation of myslice, with complete
111 user-management including registration, is taking place
114 rough/preliminary scaffolding views are in here
115 as the name suggests this is temporary
118 will receive actual views over time
119 currently has some global html templates as well
120 + some global static files (css, js, images..)
123 a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
126 * third party javascript and css stuff (bootstrapfs, jquery, this kind of things)
127 see more about that below too
130 no code in there, only various notes and other scripts useful for developers
132 ========== automatically generated
134 * all-static: (generated, no need to source-control)
135 this is where 'make static' will gather all your static contents if you run a local server
136 make has convenience targets to refresh this area
143 this is where django stores its own stuff, as per settings.py
145 ==================== conventions for templates & static files
146 ==================== and NOTES on using the development server
148 . first off, running manage.py runserver is provided by django as a development convenience but
149 SHOULD NOT be used in production
151 . second, when you do use it for developement purposes, please be aware that:
153 .. the recommended layout for the various files and pieces (py, html, js and css) with django is
154 IMHO really painful; we *SHOULD* use e.g.
155 plugins/quickfilter/quickfilter.py,
156 plugins/quickfilter/templates/quickfilter.html,
157 plugins/quickfilter/static/js/quickfilter.js
158 plugins/quickfilter/static/css/quickfilter.css
159 which I have tried doing for a while but I found myself just hopping around in the file tree all
160 day long, wasting cycles big time
162 .. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces (this is in
163 the Makefile). Bottom line is we can essentially store this wherever we want.
164 The only restriction being that if you have a template that is *not* html, then it *has to* sit
165 in a templates/ directory, otherwise it gets shipped as a static file.
167 .. as a result, we can now store all the files building a plugin in a single (git) directory; like e.g.
168 plugins/quickfilter/quickfilter.py
169 plugins/quickfilter/quickfilter.html
170 plugins/quickfilter/quickfilter.js
171 plugins/quickfilter/quickfilter.css
173 Of course it's a completely different matter once the service is packaged and installed, these
174 files of course get properly separated.
176 .. as a result it is a little bit less convenient to use the development server when you change the
177 layout of your static and template files, you might need to re-run 'make static', so it is
178 recommended to use devel/server-loop.sh instead
181 All this being said, here are our current conventions for storing templates and static files
184 we store this under templates/ within the corresponding app, e.g.
185 auth/templates/login.html
186 for now this is mostly about html, but the engine can be used for rendering anything
187 including js(on) or whatever (in which case, as stated above, this *must* have /templates/ in its path.
190 we chose to have all static files (images, but also javascript and stylesheets) in the various
191 proj or app where they belong, with a layout like:
196 Honestly it's not yet very clear sometimes what 'where-it-belongs' should be sometimes, and it
197 does not matter too much anyway, given that the code doesn't need to change when we move things
198 around. So in particular it's fuzzy between myslice/ (where the logo could fit e.g.) views/ and
201 Makefile has a few convenience targets to list all kinds of stuff; the 2 major targets are
203 $ make static templates
205 that would reset all-static/ and all-templates/ for you from the other contents
208 please note that the set of files that actually get exposed in all-static from third-party is
209 hand-coded in Makefile because we tried to preserve the original codebase layout from mainstream,
210 and there's only so much in common between 2 differents js libraries at this point.
214 ======== update django database to reflect changes in existing models without any migration system (e.g., south) =========
217 $python manage.py reset <your_app>
219 #Django 1.5.1 or later
220 $python manage.py flush
222 This will update the database tables for your app, but will completely destroy any data that existed in those tables.
223 If the changes you made to your app model do not break your old schema (for instance, you added a new, optional field)
224 you can simply dump the data before and reload it afterwards, like so:
226 $python manage.py syncdb
227 $python manage.py dumpdata <your_app> > temp_data.json
228 $python manage.py flush
229 $python manage.py loaddata temp_data.json
231 If your changes break your old schema this won't work - in which case tools like south or django evolution are great.
233 ======== update django database to reflect changes in existing models with migration system (e.g., south) =========
235 As south is already installed , you just have to do:
241 1. go to myslice directory
242 2. do sqlite3 myslice.sqlite3 [if sqlite3: command not found, do $apt-get install sqlite3]
243 3. check the list of tables with sqlite> .tables
244 4. if you find those tables that was mentioned in the failure message while running $./manage.py migrate
245 do sqlite> DROP TABLE mentioned_table
246 [mentioned_table = the tables that was explicity mentioned in the failure message of $./manage.py migrate]
248 6. $./manage.py migrate