Download as PDF, PPTX
Uploaded byAidIQ
Tech 2 - Introduction to the Code
This document provides information on setting up a development environment for Sahana Eden, including installing required software, recommended editors and debuggers, and guidelines for customizing and extending Eden through its model-view-controller architecture. Key steps include installing Python and dependencies, configuring the database, using Git for version control, and developing new modules by defining models, controllers, and views.
More Related Content
Tech 2 - Introduction to the Code
- 1. Introduction to theCode Fran Boon fran@sahanafoundation.org SahanaCamp Viet Nam 1
- 2.
- 3. Architecture Web Server n/a Application Sahana Eden WebFramework Web2Py Programming Language Python Database SQLite Operating System Windows, Linux or Mac SahanaCamp Viet Nam
- 4. Installation process Wizard onWiki to select correct instructions: http://eden.sahanafoundation.org/wiki/InstallationGuidelines Bootable USB Windows Developer Installer Mac, Linux Eden-Python-Installer-Dev.exe Follow instructions to install from source Virtual Machine SahanaCamp Viet Nam
- 5.
- 6. Editor / Debugger Notepad+good basic editor for Windows + Eclipse allows advanced debugging: set breakpoints and step through code http://eden.sahanafoundation.org/wiki/DeveloperGuidelinesEclipse Firebug allows advanced debugging of CSS and JavaScript view AJAX requests edit CSS in realtime browse DOM set breakpoints and step through code SahanaCamp Viet Nam
- 7. Edit the Menus modules/s3menus.py deforg(self): """ ORG / Organization Registry """ return M(c="org")( M("Organizations", f="organisation")( M("New", m="create"), M("List All"), M("Search", m="search"), M("Import", m="import") ), M("Venues", f="office")( M("New", m="create"), M("List All"), #M("Search", m="search"), M("Import", m="import") ), ) SahanaCamp Viet Nam
- 8.
- 9. Whitespace Matters Unlike otherlanguages which use parentheses to delimit code blocks {...}, Python instead uses White Space SahanaCamp Viet Nam
- 10. Debug Mode models/000_config.py settings.base.debug =True Reloads modules/s3db every request CSS & JavaScript unminified SahanaCamp Viet Nam
- 11. Training Module Resource: 'Course' Name Date/ Time Location: Venue Facilitator Welcome Pack SahanaCamp Viet Nam
- 12. Define the BasicData Model models/training.py tablename = "training_course" db.define_table(tablename, Field("name"), Field("start"), Field("facilitator"), ) Table Name: module_resource Database 'migrated' automatically SahanaCamp Viet Nam
- 13. Add a Controller controllers/training.py defcourse(): return s3_rest_controller() Functions map URLs to code & resources SahanaCamp Viet Nam
- 14.
- 15. Other Formats http://127.0.0.1:8000/eden/training/course .xls http://127.0.0.1:8000/eden/training/course.xml http://127.0.0.1:8000/eden/training/course .json SahanaCamp Viet Nam
- 16.
- 17.
- 18. Links to otherResources models/training.py Field("name"), s3db.pr_person_id(label="Facilitator"), SahanaCamp Viet Nam
- 19. Pivot Table Reports http://127.0.0.1:8000/eden/training/course/report SahanaCamp Viet Nam
- 20.
- 21. Which File doI Edit? http://en.flossmanuals.net/sahana-eden/customisation/ SahanaCamp Viet Nam 21
- 22.
- 23. Model View Controller Eachmodule will have: Model: modules/s3db/modulename.py Controller: controllers/modulename.py Defines the data model Links URLs to resources Views: views/modulename/index.html HTML templates with embedded python code There may be additional view files for custom pages SahanaCamp Viet Nam
- 24. Web2Py URL Mapping http://host/application/controller/function e.g.:http://127.0.0.1:8000/eden/default/index Model: not Controller: web2py/applications/eden/controllers/default.py applicable here Function: def index(): View: web2py/applications/eden/views/default/index.html SahanaCamp Viet Nam
- 25. Sahana Eden URLMapping http://host/eden/module/resource eg: http://127.0.0.1:8000/eden/org/site Model: web2py/applications/eden/modules/s3db/org.py tablename = "org_site" Controller: web2py/applications/eden/controllers/org.py Function: def site(): return s3_rest_controller() View: not applicable here SahanaCamp Viet Nam
- 26. Views HTML with Pythoninside {{..}} Extend layout.html for basic look and feel views/training/index.html {{extend "layout.html"}} <H1>Welcome to the Training Module</H1> <A href='{{=URL(f="course")}}'>Browse the Course List</A> Resource Controllers use Generic Views: web2py/applications/eden/views/_list_create.html Can customise these in the template: web2py/applications/eden/templates/template/views/_list_create.html SahanaCamp Viet Nam
- 27. Edit a FieldLabel modules/s3db/org.py tablename = "org_organisation" ... Field("donation_phone", label = T("Donation Phone Number"), SahanaCamp Viet Nam
- 28. Hide a Field modules/s3db/org.py tablename= "org_office" ... Field("type", "integer readable=False, writable=False, label=T("Type")), SahanaCamp Viet Nam
- 29. Add a NewField modules/s3db/org.py tablename = "org_organisation" ... Field("facebook", label=T("Facebook Page")), SahanaCamp Viet Nam
- 30.
- 31. Installing Git GitHub.com hasexcellent instructions Create SSH public/private keys ssh-keygen -t rsa -C "my_email@email.com" SahanaCamp Viet Nam
- 32. Creating your Branch https://github.com/flavour/eden Getlocal copy: git Stay up date: git clone git@github.com:myname/eden.git pull upstream master SahanaCamp Viet Nam
- 33. Updating your Server Commitcode locally: git Push to GitHub: git Pull on Server: git commit -a push pull SahanaCamp Viet Nam
- 34. Sharing your Code Commitcode locally: git Push to GitHub: git commit -a push Submit Pull Request to get code merged into Trunk SahanaCamp Viet Nam