source: main/waeup.cas/trunk/README.rst @ 15505

waeup.cas
*********

Install for Development
-----------------------

Create a virtualenv and install basic packages::

  $ virtualenv py27
  $ source py27/bin/activate
  (py27)$ python setup.py dev

Running Tests
-------------

After `Install for Development`_ run::

  (py27)$ py.test

We also provide support for `tox`. You can run tests in Python 2.6,
2.7, 3.2, and 3.3 environments (if you have the respective Python
versions installed locally) simply by::

  (py27)$ pip install tox   # needed only once per virtualenv
  (py27)$ tox

If you want to run tests for a specific version only, try something
like::

  (py27)$ tox -e py32

to run tests for Python 3.2 only.

Getting Test-Coverage Reports
-----------------------------

You can generate coverage reports by::

  (py27)$ py.test --cov .

This will dump reports on commandline. For HTML reports you can try::

  (py27)$ py.test --cov . --cov-report=html

Please make sure, that coverage stays at 100%.


Running the CAS Server (with `paster`)
--------------------------------------

You need some WSGI-capable HTTP-server to run CAS. One approach would
be the ``paster`` HTTP-server included in the ``PasteScript``
package::

   (py27)$ pip install PasteScript

This will provide the `paster` executable in path. Now you need a
configuration file like the ``sample.ini`` file provided in the
package root. You can run this configuration then like this::

   (py27)$ paster serve sample.ini

Afterwards you should be able to login on http://localhost:8008/login

The authentication module enabled by default is ``dummy`` and mainly
for testing. It gives a successful login for the credentials ``bird``
/ ``bebop`` (and nothing else).