| 1 | waeup.sirp |
|---|
| 2 | ********** |
|---|
| 3 | |
|---|
| 4 | The WAeUP Student Information and Registration Portal. `waeup.sirp` is |
|---|
| 5 | a web-based management tool for managing universities and schools. |
|---|
| 6 | |
|---|
| 7 | What is ``waeup.sirp``? |
|---|
| 8 | ======================= |
|---|
| 9 | |
|---|
| 10 | The package was created as an effort of the WAeUP group. See |
|---|
| 11 | http://www.waeup.org to learn more about WAeUP. |
|---|
| 12 | |
|---|
| 13 | |
|---|
| 14 | Installation |
|---|
| 15 | ============ |
|---|
| 16 | |
|---|
| 17 | .. note:: ``waeup.sirp`` might not work with Python > 2.5 |
|---|
| 18 | currently. Use of Python 2.5 is recommended. |
|---|
| 19 | |
|---|
| 20 | .. note:: ``waeup.sirp`` does not work on Windows. |
|---|
| 21 | |
|---|
| 22 | Prerequisites |
|---|
| 23 | ------------- |
|---|
| 24 | |
|---|
| 25 | The ``waeup.sirp`` package is based on `Grok`_, which is a Python |
|---|
| 26 | framework for agile webapplication development. Grok itself is based |
|---|
| 27 | on `Zope`_. |
|---|
| 28 | |
|---|
| 29 | .. _Grok: http://grok.zope.org/ |
|---|
| 30 | |
|---|
| 31 | .. _Zope: http://www.zope.org/ |
|---|
| 32 | |
|---|
| 33 | Both, Grok and Zope, are written in Python (with parts written in |
|---|
| 34 | C). You therefore need `Python`_ installed. |
|---|
| 35 | |
|---|
| 36 | .. _Python: http://www.python.org/ |
|---|
| 37 | |
|---|
| 38 | Note, that you also need the Python header files and a compiler to |
|---|
| 39 | compile the parts written in C. |
|---|
| 40 | |
|---|
| 41 | To deploy ``waeup.sirp`` most easily, we use `zc.buildout`_ |
|---|
| 42 | |
|---|
| 43 | .. _zc.buildout: http://cheeseshop.python.org/pypi/zc.buildout |
|---|
| 44 | |
|---|
| 45 | You may have setuptools already installed for your system Python. In |
|---|
| 46 | that case, you may need to upgrade it first because buildout requires |
|---|
| 47 | a very recent version:: |
|---|
| 48 | |
|---|
| 49 | $ sudo easy_install -U setuptools |
|---|
| 50 | |
|---|
| 51 | If this command fails because easy_install is not available, there is |
|---|
| 52 | a good chance you do not have setuptools available for your system |
|---|
| 53 | Python. If so, there is no problem because setuptools will be |
|---|
| 54 | installed locally by buildout. |
|---|
| 55 | |
|---|
| 56 | Bootstrap the buildout environment:: |
|---|
| 57 | |
|---|
| 58 | $ python2.5 bootstrap/bootstrap.py |
|---|
| 59 | |
|---|
| 60 | and run the buildout command:: |
|---|
| 61 | |
|---|
| 62 | $ bin/buildout |
|---|
| 63 | [lots of stuff will be downloaded and installed here] |
|---|
| 64 | |
|---|
| 65 | Note that if you have more than one sandbox for a Zope-based web |
|---|
| 66 | application, it will probably make sense to share the eggs between the |
|---|
| 67 | different sandboxes. You can tell ``zc.buildout`` to use a central |
|---|
| 68 | eggs directory by creating ``~/.buildout/default.cfg`` with the |
|---|
| 69 | following contents:: |
|---|
| 70 | |
|---|
| 71 | [buildout] |
|---|
| 72 | eggs-directory = /home/bruno/buildout-eggs |
|---|
| 73 | |
|---|
| 74 | Running the ``waeup`` application |
|---|
| 75 | --------------------------------- |
|---|
| 76 | |
|---|
| 77 | You can start Zope with the with the following command: |
|---|
| 78 | |
|---|
| 79 | $ bin/sirpctl fg |
|---|
| 80 | |
|---|
| 81 | Alternatively you can do: |
|---|
| 82 | |
|---|
| 83 | $ bin/paster serve parts/etc/deploy.ini |
|---|
| 84 | |
|---|
| 85 | If you now connect to port 8080 and log in with username 'grok', |
|---|
| 86 | password 'grok', you should be able to add the grok-based applications |
|---|
| 87 | (such as ``University``) from the menu. |
|---|
| 88 | |
|---|
| 89 | Add an instance of ``University`` and click on the link next to the |
|---|
| 90 | then visible entry in the list of installed applications. |
|---|
| 91 | |
|---|
| 92 | Running the tests |
|---|
| 93 | ----------------- |
|---|
| 94 | |
|---|
| 95 | The tests are easily run by executing the test runner that's |
|---|
| 96 | installed in the ``bin`` directory:: |
|---|
| 97 | |
|---|
| 98 | $ bin/test |
|---|
| 99 | |
|---|
