source: waeup/branches/ulif-rewrite/src/waeup/README.txt @ 3833

The waeup package
********************

:Test-Layer: unit

A portal software for student registration.

Prerequisites
=============

Before we can work with the environment, we have to register all the
utilities, adapters, etc. We grok the `waeup` package to do that::

  >>> import grok
  >>> grok.testing.grok('waeup')

Universities
============

``University`` objects are the base of all functionality provided by
this package.  They contain all facilities of a university.

We can easily create universities::

  >>> from waeup.app import University
  >>> u = University()
  >>> u
  <waeup.app.University object at 0x...>

Universities have a name.

  >>> u.name
  u'Unnamed'

Universities are basically also containers for faculties, students and
hostels::

  >>> u['faculties']
  <waeup.university.facultycontainer.FacultyContainer object at 0x...>

  >>> u['students']
  <waeup.students.studentcontainer.StudentContainer object at 0x...>

  >>> u['hostels']
  <waeup.hostel.hostelcontainer.HostelContainer object at 0x...>

Faculties
=========

Faculties are containers for departments. They are intended to be
managed by universities.

We can create faculties easily::

  >>> from waeup.university.faculty import Faculty
  >>> f = Faculty()
  >>> f
  <waeup.university.faculty.Faculty object at 0x...>

Also faculties want to be named::

  >>> f.name
  u'Unnamed Faculty'

Departments
===========