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