icemac.addressbook 0.1.2

Multi user address book application

icemac.addressbook

Purpose: Store, search and export addresses and phone numbers using a web application.

Status: working prototype (preview of the real application)

Contents

• icemac.addressbook

  • Features

  • Roles

  • Predefined users

• Installation

  • Prerequisites

  • Install

  • Run the tests

  • Run the application

  • Update

• To do

• Change log

  • 0.1.2 (2008-11-23)

  • 0.1.1 (2008-11-10)

  • 0.1 (2008-11-08)

• Download

Features

• store data of persons including (postal address, e-mail address, home page address phone number)

• assign keywords to persons

• search for persons by keyword

• export persons found by a search as XLS file

• multi-client capability

• user management (prepared)

• really good test coverage (> 96 %)

Roles

Access to the address book is only granted after authentication. There are three roles to authorize a user:

• visitor: visit all person’s data, search and export

• editor: permissions of visitor + edit all person’s data

• administrator: permissions of editor + create and change address books

Predefined users

As this version is a preview version there is no usermanagement yet. The following predefined users exist: (<username>:<password>)

• admin:admin-ia (Role: administrator)

• editor:editor-ia (Role: editor)

• visitor: visitor-ia (Role: visitor)

Installation

Prerequisites

You only need Python 2.4 or 2.5.

Install

CAUTION: icemac.addressbook can’t be installed using easy_install, you have to follow these steps:

• Download the source distribution (see Download).

• Extract the downloaded file.

• Run install.py using your desired python, e. g.:

  $ python2.5 install.py

Neither you need any root privileges nor it installs anything outside its directory.

Run the tests

Run the unit tests and functional tests using:

$ bin/test

Run the application

The server runs on 127.0.0.1:8080. To change this edit deploy.ini.

To run in foreground start using:

$ bin/addressbook fg

To run as a demon process start using:

$ bin/addressbook start

To stop the demon process call:

$ bin/addressbook stop

Update

• Stop the application.

• Create a backup of the ZODB using:

  $ bin/backup

• Do the steps described in Install.

• Copy the backup directory (var/backups) to the new directory.

• Restore the backup using:

  $ bin/restore

• Restart the application.

To do

The following features should be implemented over the next months:

• user management

• person data

  • store picture per person

  • add customizable free text fields

  • additional addresses/phone numbers per person

• company as entity

• import

  • vCard

  • XLS

  • SQLite (Apple’s Addressbook.app)

• export

  • custom XLS export

  • full export

  • LDAP export

• translation of user interface into German

• better search

  • full text search

  • combined search

  • wildcard search

Change log

0.1.2 (2008-11-23)

• Added recipe to safely install lxml dependency.

0.1.1 (2008-11-10)

• Initial public release.

0.1 (2008-11-08)

• create pypi homepage

Download