2.2 Installing

#
2.2 Installing

Unpack the package archive to extract the package source. This will create an `albatross-1.33` subdirectory.

    tar xzf albatross-1.33.tar.gz

Inside the `albatross-1.33` directory are a number of directories.

  `albatross`

  Contains the Python code for the package.

  `doc`

  Contains the documentation source.

  `samples`

  Contains all of the sample programs discussed in this document.

  `session-server`

  Contains a simple session server which works with the Albatross server-side session mixin classes.

  `test`

  Contains the unit tests.

The `Albatross` package uses the `distutils` package so all you need to do is type the following command as root from the top level directory:

    python setup.py install

If you have problems with this step, make sure that you contact the package author so that the installation process can be made more robust for other people.

If you already have a copy of Albatross installed and wish to test the new release before installing it globally then you can install an application private copy. If your application is installed in `/path/to/proj` then the following command will install a copy of Albatross that is only visible to that application:

    python setup.py install --install-lib /path/to/proj --install-scripts /path/to/proj

If you wish to build the documentation you will almost certainly need to change first line of the `Makefile` in the documentation directory. This points to where you have unpacked the Python distribution so the `Makefile` can find the `mkhowto` program.

    cd doc
    make pdf
    make html