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
12 $ apt-get install python-django
13 $ apt-get install python-django-south
15 * git clone git://git.onelab.eu/myslice.git
17 * git clone ssh://yourlogin@git.onelab.eu/git/myslice.git
19 * edit myslice/config.py and enter the details of your manifold backend
21 $ apt-get install python-django-south
23 ** when django prompts for creating an admin account, create it and
24 ** keep the username and password safe
29 $ ./manage.py collectstatic
31 $ ./manage.py collectstatic --noinput
33 $ make static (which is a shorthand for cleaning up and run manage collectstatic --noinput)
35 * gather templates files
36 for now we still seem to rely on a make-based templates-collection process
37 that creates templates/
38 $ make templates [$ make redo (each time when you pull, do that and restart the server)]
41 ## Whenever doing a git pull the following operations are recommended:
43 $ make static # will refresh static/ from all the pieces in the project
44 $ make templates # same, for templates
45 $ make redo-static # clears up (rm -rf) static/ first, then make static
46 $ make redo-templates # ditto for templates
47 $ make redo == make redo-static redo-templates
51 $ ./manage.py runserver 0.0.0.0:8000
53 $ devel/server-loop.sh
54 when you just need to hit ^C yourself when your static files need to be refreshed - see below
56 * use it from your browser
57 (See more notes on using the development server below)
59 * install dependencies
60 $ pip install -r path/to/requirements/file.txt
61 Note. not quite sure what this is about, I could not spot this file..
63 ==================== Status
65 *** Authentication ***
68 Not quite sure if/how the user gets proper notifications when
69 . his session has expired (i.e. his frontend is not logged into the backend any longer)
70 . his credentials have expired (i.e. the uploaded credentials, e.g. SFA delegated cred)
71 expired and she needs to run e.g. sfi myslice again
73 Hard-coded accounts (from a very early stage) are gone
78 I've done a very rough attempt at packaging for rpm.
79 The logic seems about right but needs more work, in particular in terms of installing myslice.conf
80 in the httpd conf.d directory.
81 It seems like our app won't work on f14 as is because Django is only 1.3.1 on f14
82 Plan is to target f18 but I lack a test machine.
83 Also of course I'll try to tackle debian/ubunti at some point.
85 There also is a working packaging for debian(s) and ubuntu(s) that we use
86 on an almost daily basis to upgrade manifold.pl.sophia.inria.fr
91 Third party tools shipped:
98 Others are added as we build the system when they become needed
99 Look in third-party/ for a more detailed list
101 As a rule of thumb, please try to keep in mind that these will need to
102 be upgraded over time I've tried to keep track of the version I picked
103 and to have an easy upgrade path (depending on the way the original
104 package is published)
106 ==================== Contents: 1st level subdirs
108 ========== code from git
111 this is the django 'project', where to look for
116 the code for dealing with queries, sending them to the backend, and offering the /manifold/proxy/ URL
119 the code for building / rendering plugins
122 the actual code for plugins
125 a django 'app' that deals with authentication; see especially
126 auth.backend.MyCustomBackend
127 for how to use a separate authentication system,
128 as well as settings.py for how to enable it
131 provides building blocks for the UI, especially layouts (1 or 2 columns) as
132 well as the topmenu widget
133 + some global static files (css, js, images..)
136 this is where the first implementation of myslice, with complete
137 user-management including registration, is taking place
140 rough/preliminary scaffolding views are in here
141 as the name suggests this is temporary
144 a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
147 * third party javascript and css stuff (bootstrapfs, jquery, this kind of things)
148 see more about that below too
151 no code in there, only various notes and other scripts useful for developers
153 ========== automatically generated
155 * static/: (generated by collectstatic, see above, do not source-control)
156 $ manage.py [ --noinput ] collectstatic
161 this is where django stores its own stuff, as per settings.py
163 ==================== conventions for templates & static files
164 ==================== and NOTES on using the development server
166 . first off, running manage.py runserver is provided by django as a development convenience but
167 SHOULD NOT be used in production
169 . second, when you do use it for developement purposes, please be aware that:
171 .. the recommended layout for the various files and pieces (py, html, js and css) with django is e.g.
172 plugins/quickfilter/___init__.py,
173 plugins/quickfilter/templates/quickfilter.html,
174 plugins/quickfilter/static/js/quickfilter.js
175 plugins/quickfilter/static/css/quickfilter.css
176 plugins/quickfilter/static/img/some-image.png
178 .. the files actually used by the development server are the ones located in
182 you can and should use the following make targets to refresh the
183 contents of these directories when running a developement server
184 $ make static to refresh static/
185 $ make redo-static to clean up static/ and then refresh its contents
186 $ make templates to refresh templates/
187 $ make redo-templates to clean up templates/ and then refresh its contents
188 $ make redo equivalent to make redo-static redo-templates
190 .. as far as possible, please make sure to use third-party to store
191 any javascript tool or utility that your plugin depends upon
193 also we have the convention that all material in third-party should be
194 tagged with a version number, with a symlink pointing to the version
195 being used, like this
197 ~/git/myslice/third-party $ ls -ld spin*
198 lrwxr-xr-x 1 parmentelat staff 10 Sep 6 17:55 spin -> spin-1.3.0
199 drwxr-xr-x 7 parmentelat staff 238 Sep 6 17:55 spin-1.2.8
200 drwxr-xr-x 7 parmentelat staff 238 Sep 6 17:55 spin-1.3.0
202 finally, as far as possible we keep track of the urls used to pull
203 stuff in the first place so that upgrades are easier
205 . third, be careful when importing third party material, to stay away from demo-oriented material
207 e.g. at some point we were using demo_page.css and demo_table.css from the datatables demo and sample pages
208 unfortunately these are not tailored for production use as they are setting styles on a very wide scope
209 that breaks a lot of stuff, so please refrain from using these altogether
212 ======== update django database to reflect changes in existing models without any migration system (e.g., south) =========
215 $python manage.py reset <your_app>
217 #Django 1.5.1 or later
218 $python manage.py flush
220 This will update the database tables for your app, but will completely destroy any data that existed in those tables.
221 If the changes you made to your app model do not break your old schema (for instance, you added a new, optional field)
222 you can simply dump the data before and reload it afterwards, like so:
224 $python manage.py syncdb
225 $python manage.py dumpdata <your_app> > temp_data.json
226 $python manage.py flush
227 $python manage.py loaddata temp_data.json
229 If your changes break your old schema this won't work - in which case tools like south or django evolution are great.
231 ======== update django database to reflect changes in existing models with migration system (e.g., south) =========
233 As south is already installed , you just have to do:
239 1. go to myslice directory
240 2. do sqlite3 myslice.sqlite3 [if sqlite3: command not found, do $apt-get install sqlite3]
241 3. check the list of tables with sqlite> .tables
242 4. if you find those tables that was mentioned in the failure message while running $./manage.py migrate
243 do sqlite> DROP TABLE mentioned_table
244 [mentioned_table = the tables that was explicity mentioned in the failure message of $./manage.py migrate]
246 6. $./manage.py migrate