Subsections

2 Installation

To install PyORQ, unpack the tar file you downloaded, and run python setup.py install. For example, on Linux:

tar -xvzf PyORQ-0.1.tar.gz
cd PyORQ-0.1
python setup.py install

This assumes that you have write privileges in the site-packages directory of your Python distribution. If you don't have the necessary permissions, or if you just want to test PyORQ, you can also just add the directory that was created when unpacking PyORQ to your PYTHONPATH environment variable.

PyORQ assumes that you have access to one of the supported databases ( PostgreSQL, MySQL or SQLite), and that you have installed the corresponding Python interface (pyPgSQL, MySQL-Python, or PySQLite).

In the case of MySQL and PostgreSQL you will also need to know your username, password and the name of the database, and, if the server is not located on your machine, the name of the host.

2.1 Running the tests

If you wish, you can run the unit tests supplied with the source distribution.

Make sure that PyORQ is installed, or that the installation directory is added to your PYTHONPATH environment variable. If you plan to use either the MySQL interface and/or the PostgreSQL interface, make sure that they contain a database 'testdb', and that your login-name is also your username for these databases.

Change directory to 'test' and run

python query_test

This tests, for each available interface, whether the low-level library is available and whether you can connect to the database. If successful, it will populate the database with some test data, and execute a number of queries.