Version 107 (modified by Fran Boon, 14 years ago) ( diff )


Developer Guide

Install a Development Environment


Indentation matters (use 4 spaces instead of Tabs)

More details at: DeveloperGuidelinesCodeConventions


This is an MVC environment (like Rails & Django. Django polls turorial conversion course).

Web2Py can work at several different levels of abstraction.
The Sahana Eden framework (S3) is built on Web2Py's Auth/Crud classes in (with some remnants of the older T2), however sometimes we need more control therefore need to drop down a level or two.

Recommend using the CLI to try out code snippets in the Web2Py environment (gluon, Model):

python -S eden -M

Web2Py can be extended through Plugins & also has a recipes site.


Defines databases in: /models/

The Models are loaded 1st within Web2Py processing, before the controllers.
So you can import any global modules/set any global variables here.
The Models are imported in alphabetical order, so we load the files which other modules depend on 1st, hence naming them appropriately:,,,, etc


Python functions in /controllers/

   def list_records():
       items =
       return dict(items=items)


HTML/Javascript templates in /views/module/function.html

  • these are normal HTML/JS files with the ability to add in Python code (e.g. variables) surrounded by brackets: {{ interpreted python here }}
  • there should be an .html file available for each function in the module (name normally being the same as the function)
  • these normally inherit from views/layout.html which also includes the JavaScript from views/*_ajax.html
  • if there is no view defined then a default view will be displayed, which will show the values of all the data it can see, but not be formatted nicely

Static CSS/Javascript files are stored in /static


Reserved Keywords

Developer Guidelines


Note: See TracWiki for help on using the wiki.