1 his file documents the contents of this module
3 See the devel/ subdir for more devel-oriented doc.
5 ==================== 1 minute howto
7 * REQUIREMENTS is to have python + django installed django
8 ** should be straightforward
9 ** see devel/django-install.txt in case of trouble
11 * git clone git://git.onelab.eu/myslice-django.git
13 * git clone ssh://yourlogin@git.onelab.eu/git/myslice-django.git
15 * edit myslice/settings.py and
16 ** change DEVELOPER_ROOT if you didnt clone into ~/git/myslice-django
17 ** change the location of your backend API (not yet supported)
19 * edit myslice/config.py and enter the details of your manifold backend
28 $ manage.py runserver 0.0.0.0:8000
30 $ devel/server-loop.sh
31 when you just need to hit ^C yourself when your static files need to be refreshed - see below
33 * use it from your browser
35 .......... NOTES on using the development server
36 . first off, running manage.py runserver is provided by django as a development convenience but SHOULD NOT be used in production
37 . second, when you do use it for developement purposes, please be aware that:
38 .. the recommended layout for the various files and pieces (py, html, js and css) qith django is really painful
39 we should use e.g. plugins/simplelist.py, plugins/templates/plugins.html, plugins/static/js/simplelist.js and plugins/static/css/simplelist.css
40 .. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces in such a layout but from a completely flat codebase
41 I mean I want to be able to store all the files building a plugin in a single (git) directory
42 Of course it's a completely different matter once the service is packaged and installed, these files of course get properly separated.
43 .. as a result it is a little bit less convenient to use the development server
44 when you change the layout of your static and template files, you might need to re-run 'make static', so it is recommended to use
45 devel/server-loop.sh instead
48 ==================== Status
50 *** Authentication ***
52 Although there still are a few hard-coded accounts in the system, you
53 will only be able to see some static views and won't be able to send
54 real queries if you use these, so you'd better use a real account (one
55 that your manifold backend knows about).
57 For logging out: click on 'logged as *jean*', this shows a
58 confirmation page for logging out. this is intended to be temporary.
63 We have a basic model for asynchroneous queries (referring to manifold
64 queries) and for plugins (in the most general sense a plugin is just a
65 piece of the output that may be connected to a query)
67 Right now the UI has a handful of demo views only; as of this writing
68 only the list of slices actually comes from the manifold backend in an
71 Also all the views are gathered in the trash/ locations for now, being
72 that they're only for assessment purposes.
74 * dahsboard : has one async. query and 2 plugins that share that
75 query; the intent was to demo a different layout in both cases,
76 although the datatables one won't work yet at this point.
78 * the 'Plugin' view demonstrates most of the available plugins.
80 * slice view : only demonstrates how to use URLs to pass arguments along
82 * scroll view : mostly it only illustrates that some pages can be made
83 public (no need to login)
85 * tab view : a hand-made tab widget
87 Not much effort has yet been put into coming up with a nice layout,
88 feel free to tweak that but it's probably still way too early for
93 Third party tools shipped:
100 I've tried to keep track of the version I picked and to have an easy upgrade path.
102 ==================== Contents: 1st level subdirs
104 ========== code from git
106 this is the django 'project', where to look for
111 the code for building / rendering plugins / queries
114 the actual code for plugins
117 a django 'app' that deals with authentication; see especially
118 auth.backend.MyCustomBackend
119 for how to use a separate authentication system,
120 as well as settings.py for how to enable it
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 rough/preliminary views in here - as the name suggests this is temporary
129 will receive actual views over time
130 currently has some global html templates as well
133 * third party stuff (bootstrapfs, jquery, datatables)
134 * + some global static files (css, js, images..)
135 see more about that below too
138 no code in there, only various notes and other scripts useful for developers
140 ========== automatically generated
142 * all-static: (generated, no need to source-control)
143 this is where 'make static' will gather all your static contents if you run a local server
144 make has convenience targets to refresh this area
149 this is where django stores its own stuff, as per settings.py
151 ==================== conventions for templates
154 we store this under templates/ within the corresponding app, e.g.
155 auth/templates/login.html
156 for now this is mostly about html, but the engine can be used for rendering anything
157 including js(on) or whatever..
159 ==================== conventions for static files
162 we chose to have all static files (images, but also javascript and stylesheets) in the various
163 proj or app where they belong, under a static/ subdir that has this structure:
170 NOTE. in essence any of these files can be moved around (from e.g. one templates/ dir to another)
171 at any time without any change needed in the code
173 * filenames / locations
175 you can run the following make targets to have a summary of where things are
177 $ make list-html list-js list-css list-img
181 as far as possible it's great to have things named the same after e.g. say a plugin name
183 plugins/quickfilter.py
184 plugins/templates/quickfilter.html
185 plugins/static/js/quickfilter.js
186 plugins/static/css/quickfilter.css
188 it's sometimes not working though, so here are a few additional conventions
190 the global layout (for now I needed only one) is named layout-myslice.html
191 it provides the global layout with one menu stuck on top and 2 divs 3/4 1/4
193 the views that I currently have are all named in templates/view-<>.html
194 they all extend a layout
195 they should/could admittedly move where they belong (in auth/slice/engine)
196 so that they would go with their views.py code, but for now it's impler this way
198 and there are 3 'widgets' (login, logout, and topmenu)
199 these could maybe be best implemented as a plugin now that I have the right model for that
200 however esp. for the login/logout I'm not quite sure this will remain over time
201 so for now it's good enough like this
203 So in summary there's still room for a lot of improvement on this particular topic..
204 At the very least topmenu should be made a plugin, and maybe also login/logout