This file documents the contents of this module
-
+change
Last update 4 sept. 2013
See the devel/ subdir for more devel-oriented doc.
* REQUIREMENTS is to have python + django (1.5.2) installed django
** should be straightforward
** see devel/django-install.txt in case of trouble
+$ apt-get install python-django
+$ apt-get install python-django-south
* git clone git://git.onelab.eu/myslice.git
-- or --
* git clone ssh://yourlogin@git.onelab.eu/git/myslice.git
-* edit myslice/config.py and enter the details of your manifold backend
+* edit/create myslice/myslice.ini and enter the details of your manifold backend
+$ apt-get install python-django-south
* init django
+** when django prompts for creating an admin account, create it and
+** keep the username and password safe
$ ./manage.py syncdb
$ ./manage.py migrate
* gather static files
-$ ./manage.py collectstatic (formerly, we used make static, which is deprecated)
+$ ./manage.py collectstatic
-- or --
$ ./manage.py collectstatic --noinput
-$ make
+-- or --
+$ make static (which is a shorthand for cleaning up and run manage collectstatic --noinput)
+
+* gather templates files
+ for now we still seem to rely on a make-based templates-collection process
+ that creates templates/
+$ make templates [$ make redo (each time when you pull, do that and restart the server)]
+
+
+## Whenever doing a git pull the following operations are recommended:
+
+$ make static # will refresh static/ from all the pieces in the project
+$ make templates # same, for templates
+$ make redo-static # clears up (rm -rf) static/ first, then make static
+$ make redo-templates # ditto for templates
+$ make redo == make redo-static redo-templates
+
* run a local server:
-$ manage.py runserver 0.0.0.0:8000
+$ ./manage.py runserver 0.0.0.0:8000
-- or -- my advice:
$ devel/server-loop.sh
when you just need to hit ^C yourself when your static files need to be refreshed - see below
for how to use a separate authentication system,
as well as settings.py for how to enable it
+* ui/
+ provides building blocks for the UI, especially layouts (1 or 2 columns) as
+ well as the topmenu widget
+ + some global static files (css, js, images..)
+
* portal/
this is where the first implementation of myslice, with complete
user-management including registration, is taking place
rough/preliminary scaffolding views are in here
as the name suggests this is temporary
-* views/
- will receive actual views over time
- currently has some global html templates as well
- + some global static files (css, js, images..)
-
* insert_above:
a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
========== automatically generated
-* all-static: (generated, no need to source-control)
- this is where 'make static' will gather all your static contents if you run a local server
- make has convenience targets to refresh this area
- $ make static
- $ make clean-static
+* static/: (generated by collectstatic, see above, do not source-control)
+ $ manage.py [ --noinput ] collectstatic
-* django-static
+* templates/
* myslice.sqlite3
this is where django stores its own stuff, as per settings.py
. second, when you do use it for developement purposes, please be aware that:
-.. the recommended layout for the various files and pieces (py, html, js and css) with django is
- IMHO really painful; we *SHOULD* use e.g.
- plugins/quickfilter/quickfilter.py,
+.. the recommended layout for the various files and pieces (py, html, js and css) with django is e.g.
+ plugins/quickfilter/___init__.py,
plugins/quickfilter/templates/quickfilter.html,
plugins/quickfilter/static/js/quickfilter.js
plugins/quickfilter/static/css/quickfilter.css
- which I have tried doing for a while but I found myself just hopping around in the file tree all
- day long, wasting cycles big time
-
-.. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces (this is in
- the Makefile). Bottom line is we can essentially store this wherever we want.
- The only restriction being that if you have a template that is *not* html, then it *has to* sit
- in a templates/ directory, otherwise it gets shipped as a static file.
-
-.. as a result, we can now store all the files building a plugin in a single (git) directory; like e.g.
- plugins/quickfilter/quickfilter.py
- plugins/quickfilter/quickfilter.html
- plugins/quickfilter/quickfilter.js
- plugins/quickfilter/quickfilter.css
-
- Of course it's a completely different matter once the service is packaged and installed, these
- files of course get properly separated.
-
-.. as a result it is a little bit less convenient to use the development server 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 devel/server-loop.sh instead
+ plugins/quickfilter/static/img/some-image.png
+.. the files actually used by the development server are the ones located in
+ static/
+ templates/
-All this being said, here are our current conventions for storing templates and static files
+you can and should use the following make targets to refresh the
+contents of these directories when running a developement server
+$ make static to refresh static/
+$ make redo-static to clean up static/ and then refresh its contents
+$ make templates to refresh templates/
+$ make redo-templates to clean up templates/ and then refresh its contents
+$ make redo equivalent to make redo-static redo-templates
-* templates:
- we store this under templates/ within the corresponding app, e.g.
- auth/templates/login.html
- for now this is mostly about html, but the engine can be used for rendering anything
- including js(on) or whatever (in which case, as stated above, this *must* have /templates/ in its path.
+.. as far as possible, please make sure to use third-party to store
+any javascript tool or utility that your plugin depends upon
-* static files:
- we chose to have all static files (images, but also javascript and stylesheets) in the various
- proj or app where they belong, with a layout like:
- where-it-belongs/
- img/
- css/
- js/
- Honestly it's not yet very clear sometimes what 'where-it-belongs' should be sometimes, and it
- does not matter too much anyway, given that the code doesn't need to change when we move things
- around. So in particular it's fuzzy between myslice/ (where the logo could fit e.g.) views/ and
- even trash/
+also we have the convention that all material in third-party should be
+tagged with a version number, with a symlink pointing to the version
+being used, like this
-Makefile has a few convenience targets to list all kinds of stuff; the 2 major targets are
+~/git/myslice/third-party $ ls -ld spin*
+lrwxr-xr-x 1 parmentelat staff 10 Sep 6 17:55 spin -> spin-1.3.0
+drwxr-xr-x 7 parmentelat staff 238 Sep 6 17:55 spin-1.2.8
+drwxr-xr-x 7 parmentelat staff 238 Sep 6 17:55 spin-1.3.0
-$ make static templates
+finally, as far as possible we keep track of the urls used to pull
+stuff in the first place so that upgrades are easier
-that would reset all-static/ and all-templates/ for you from the other contents
-
-* third-party
- please note that the set of files that actually get exposed in all-static from third-party is
- hand-coded in Makefile because we tried to preserve the original codebase layout from mainstream,
- and there's only so much in common between 2 differents js libraries at this point.
+. third, be careful when importing third party material, to stay away from demo-oriented material
+e.g. at some point we were using demo_page.css and demo_table.css from the datatables demo and sample pages
+unfortunately these are not tailored for production use as they are setting styles on a very wide scope
+that breaks a lot of stuff, so please refrain from using these altogether
======== update django database to reflect changes in existing models without any migration system (e.g., south) =========
If your changes break your old schema this won't work - in which case tools like south or django evolution are great.
+
+Add a new model to the DB
+
+$python manage.py schemamigration <your_app> --auto
+$python manage.py migrate
+
======== update django database to reflect changes in existing models with migration system (e.g., south) =========
As south is already installed , you just have to do:
git://git.onelab.eu / myslice.git / blobdiff