Packaging source

If you merely want to deliver the source to your PyQt application, you might as well create a nice package structure. You can zip the source-code up or tar it down, and deliver it. You'd package the code with a clear README file that details what settings should be altered in either the .profile (or .bashrc), or, for Windows, to add a variable to the environment using the friendly dialog window Control Panel provides.

One of those settings will probably be the PYTHONPATH variable. If the application is divided into several modules (as Kalam is), the PYTHONPATH must include the top-level directory where the source is installed. It is not a good idea to install application source into the Python modules directory.

Example 26-1. README

   Kalam - the undocumented, extensible editor.

Kalam is an editor written in Python and PyQt as an example
application to accompany the third part of the book "Gui programming
with Python and Qt", published by OpenDocs.

You can extend Kalam with macro's written in Python. See edmund.py
for an example. Consult either the book, or the file kalamconfig.py
to configure Kalam, using, for instance startup.py.

   Installation

In order to run Kalam, the kalam main directory needs to be on the
Python path. On Unix, you can add something like:
PYTHONPATH=/path/to/kalam/directory:$PYTHONPATH to .bashrc. On
Windows, you must edit that system variable using the Control Panel.

   Requirements:

you must have Python (>2.0) and PyQt (>2.4) installed. PyQt depends
on sip. You can get Python from www.python.org and PyQt from
www.thekompany.com.

Boudewijn Rempt
boud@rempt.xs4all.nl
      

This is the easiest way out for you as a developer. You can also use Python's distutils to create a source distribution of your application. Since this is the first step to a binary distribution, it's a good idea to use distutils, even for source-only distributions.