README

   1 his file documents the contents of this module
   2
   3 See the devel/ subdir for more devel-oriented doc.
   4
   5 ==================== 1 minute howto
   6
   7 *  REQUIREMENTS  is to have python + django installed django
   8 ** should be straightforward
   9 ** see devel/django-install.txt in case of trouble
  10
  11 * git clone git://git.onelab.eu/myslice-django.git
  12 -- or --
  13 * git clone ssh://yourlogin@git.onelab.eu/git/myslice-django.git
  14
  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)
  18
  19 * edit myslice/config.py and enter the details of your manifold backend
  20
  21 * init django
  22 $ manage.py syncdb
  23
  24 * gather static files
  25 $ make static
  26
  27 * run a local server:
  28 $ manage.py runserver 0.0.0.0:8000
  29 -- or -- my advice:
  30 $ devel/server-loop.sh
  31 when you just need to hit ^C yourself when your static files need to be refreshed - see below
  32
  33 * use it from your browser
  34 (See more notes on using the development server below)
  35
  36 * install dependencies
  37 $ pip install -r path/to/requirements/file.txt
  38
  39 ==================== Status
  40
  41 *** Authentication ***
  42
  43 Although there still are a few hard-coded accounts in the system, you
  44 will only be able to see some static views and won't be able to send
  45 real queries if you use these, so you'd better use a real account (one
  46 that your manifold backend knows about).
  47
  48 For logging out: click on 'logged as *jean*', this shows a
  49 confirmation page for logging out. this is intended to be temporary.
  50
  51 *** Packaging ***
  52
  53 I've done a very rough attempt at packaging for rpm.
  54 The logic seems about right but needs more work, in particular in terms of installing myslice.conf
  55 in the httpd conf.d directory.
  56 It seems like our app won't work on f14 as is because Django is only 1.3.1 on f14
  57 Plan is to target f18 but I lack a test machine.
  58 Also of course I'll try to tackle debian/ubunti at some point.
  59
  60 *** Features ***
  61
  62 We have a basic model for asynchroneous queries (referring to manifold
  63 queries) and for plugins (in the most general sense a plugin is just a
  64 piece of the output that may be connected to a query)
  65
  66 Right now the UI has a handful of demo views only; as of this writing
  67 only the list of slices actually comes from the manifold backend in an
  68 asynchroneous way.
  69
  70 Also all the views are gathered in the trash/ locations for now, being
  71 that they're only for assessment purposes.
  72
  73 * dahsboard : has one async. query and 2 plugins that share that
  74   query; the intent was to demo a different layout in both cases,
  75   although the datatables one won't work yet at this point.
  76
  77 * the 'Plugin' view demonstrates most of the available plugins.
  78
  79 * slice view : only demonstrates how to use URLs to pass arguments along
  80
  81 * scroll view : mostly it only illustrates that some pages can be made
  82   public (no need to login)
  83
  84 * tab view : a hand-made tab widget
  85
  86 Not much effort has yet been put into coming up with a nice layout,
  87 feel free to tweak that but it's probably still way too early for
  88 this.
  89
  90 ====================
  91
  92 Third party tools shipped:
  93
  94 * jquery
  95 * datatables
  96 * spin
  97 * bootstrap
  98 * and others are added as we build the system when they become needed
  99
 100 I've tried to keep track of the version I picked and to have an easy upgrade path.
 101
 102 ==================== Contents: 1st level subdirs
 103
 104 ========== code from git
 105 * myslice:
 106   this is the django 'project', where to look for
 107   . settings.py
 108   . urls.py
 109
 110 * manifold:
 111   the code for dealing with queries, sending them to the backend, and offering the /manifold/proxy/ URL
 112
 113 * unfold:
 114   the code for building / rendering plugins
 115
 116 * plugins:
 117   the actual code for plugins
 118
 119 * auth:
 120   a django 'app' that deals with authentication; see especially
 121   auth.backend.MyCustomBackend
 122   for how to use a separate authentication system,
 123   as well as settings.py for how to enable it
 124
 125 * trash/
 126   rough/preliminary views in here - as the name suggests this is temporary
 127
 128 * views/
 129   will receive actual views over time
 130   currently has some global html templates as well
 131   + some global static files (css, js, images..)
 132
 133 * insert_above:
 134   a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
 135
 136 * third-party/
 137    * third party javascript and css stuff (bootstrapfs, jquery, this kind of things)
 138      see more about that below too
 139
 140 * devel:
 141   no code in there, only various notes and other scripts useful for developers
 142
 143 ========== automatically generated
 144
 145 * all-static: (generated, no need to source-control)
 146   this is where 'make static' will gather all your static contents if you run a local server
 147   make has convenience targets to refresh this area
 148   $ make static
 149   $ make clean-static
 150
 151 * myslice.sqlite3
 152   this is where django stores its own stuff, as per settings.py
 153
 154 ==================== conventions for templates & static files
 155 ==================== and NOTES on using the development server
 156
 157 . first off, running manage.py runserver is provided by django as a development convenience but
 158   SHOULD NOT be used in production
 159
 160 . second, when you do use it for developement purposes, please be aware that:
 161
 162 .. the recommended layout for the various files and pieces (py, html, js and css) with django is
 163    IMHO really painful; we *SHOULD* use e.g.
 164       plugins/simplelist.py,
 165       plugins/templates/plugins.html,
 166       plugins/static/js/simplelist.js
 167       plugins/static/css/simplelist.css
 168    which I have tried doing for a while but I found mmyself just hopping around in the file tree all
 169    day long, wasting cycles all along
 170
 171 .. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces (this is in
 172    the Makefile). Bottom line is we can essentially store this wherever we want.
 173    The only restriction being that if you have a template that is *not* html, then it *has to* sit
 174    in a templates/ directory, otherwise it gets shipped as a static file.
 175
 176 .. as a result, we can now store all the files building a plugin in a single (git) directory; like e.g.
 177       plugins/quickfilter/quickfilter.py
 178       plugins/quickfilter/quickfilter.html
 179       plugins/quickfilter/quickfilter.js
 180       plugins/quickfilter/quickfilter.css
 181
 182    Of course it's a completely different matter once the service is packaged and installed, these
 183    files of course get properly separated.
 184
 185 .. as a result it is a little bit less convenient to use the development server when you change the
 186    layout of your static and template files, you might need to re-run 'make static', so it is
 187    recommended to use devel/server-loop.sh instead
 188
 189
 190 All this being said, here are our current conventions for storing templates and static files
 191
 192 * templates:
 193   we store this under templates/ within the corresponding app, e.g.
 194      auth/templates/login.html
 195   for now this is mostly about html, but the engine can be used for rendering anything
 196   including js(on) or whatever (in which case, as stated above, this *must* have /templates/ in its path.
 197
 198 * static files:
 199   we chose to have all static files (images, but also javascript and stylesheets) in the various
 200   proj or app where they belong, with a layout like:
 201   where-it-belongs/
 202       img/
 203       css/
 204       js/
 205   Honestly it's not yet very clear sometimes what 'where-it-belongs' should be sometimes, and it
 206   does not matter too much anyway, given that the code doesn't need to change when we move things
 207   around. So in particular it's fuzzy between myslice/ (where the logo could fit e.g.) views/ and
 208   even trash/
 209
 210 Makefile has a few convenience targets to list all kinds of stuff; the 2 major targets are
 211
 212 $ make static templates
 213
 214 that would reset all-static/ and all-templates/ for you from the other contents
 215
 216 * third-party
 217   please note that the set of files that actually get exposed in all-static from third-party is
 218   hand-coded in Makefile because we tried to preserve the original codebase layout from mainstream,
 219   and there's only so much in common between 2 differents js libraries at this point.
 220
 221
 222