Installation

These docs only cover installing PyKDE from source (ie building and compiling PyKDE). You should read the "Testing" section at the end of this page even if installing from RPMs. RPM installs also have the same System Requirements as noted in the next section (except qmake).

Before reporting bugs, please read the Troubleshooting and build.py Options pages.

System Requirements

PyKDE only runs on Linux or other Unix-based systems. In addition to the usual tools (compiler, linker, make, etc), the following are also required:

qmake
qmake is a make file generator available from TrollTech (the people who do the Qt widget set). It should be in the qt3/bin/ subdirectory - if not, you can obtain qmake by downloading the Qt source distribution from here Normally, if you have Qt installed, you will already have qmake.
sip
sip must be installed. sip is the bindings code generator and run-time lib for PyKDE. You can get it here
PyQt
PyQt must be installed Just as KDE depends on Qt, PyKDE depends on PyQt. If you don't already have PyQt installed, you can get it here

NOTE: sip, PyQt, and PyKDE must be compatible versions (the PyKDE build script will test for this). That means if you are installing PyKDE-3.8, you must have installed:

At the present time, sip 4.0 has not had a final release. PyKDE 3.8 will not work with sip 4.0 or later versions of sip.

Of course you must also have Python (any version from 1.5.2 through 2.3.1), KDE (any KDE 3.0 or 3.1 version) and Qt (any version from 3.0 through 3.2) installed. PyKDE no longer supports KDE1 or KDE2, and does not yet support KDE 3.2. KDE3.2 will supported when the final release is available.

If PyQt was installed from an RPM ---

PyKDE requires the PyQt sip files. If you installed PyQt from an RPM, you also need to have installed the corresponding "PyQt-devel" RPM, which contains the PyQt sip files.

Installing from source code

Unpack the PyKDE tarball to a directory you have write access to. /usr/local is a good choice if you have write access or can obtain it. Some place in your home directory is also a good choice. I'll assume /usr/local for these instructions.

Change to the PyKDE directory (eg "cd /usr/local/PyKDE-3.8" or whatever the complete version of the downloaded PyKDE package was).

At a command line prompt, enter:

    python build.py

build.py will check your system to locate Python and releated files, Qt, KDE, sip and PyQt. It will also run several tests, and then begin generating the C++ code a make files for PyKDE. The entire process should take about 5 to 20 minutes depending on your computer's speed and available memory. build.py will report its progress throughout its run. If errors occur, see the sections on troubleshooting below.

Afte build.py has run to completion successfully, you next need to compile PyKDE. Simply type:

    make

PyKDE takes anywhere from 15 minutes to over an hour to compile, depending on the speed of your computer, available memory, and other tasks running. Once PyKDE has compiled, do:

    su -c"make install"

Your system will ask for your root password, and if entered correctly will proceed to install PyKDE. At the end of the installation, make will run 'ldconfig' which may take 30 seconds or more - be patient.

Testing the installation

There are a number of things you can do to test your installation. The simplest test that also covers the most common errors is (still in the top level PyKDE directory):

    python importTest.py

If you get errors running this test, see the troubleshooting section below.

There are some unit tests (mostly to cover special handwritten code) in the tests/ subdirectory:

    cd tests
    python autotest.py
There are also sample programs you can run (which also test some of PyKDE's features) in the examples/ and templates/ subdirectories.