trunk/python/README.txt

                                 ROUTINO PYTHON
                                 ==============

This directory contains a Python version 3 interface to the Routino routing
database that allows routes to be calculated and the database to be accessed.

Compilation
-----------

To compile the Python module run 'make'.  A working Python 3 installation and
the Swig tool are required to be able to compile this Python module.  If they
are not available then a warning will be printed but no error occur.

Running 'make' in the top level directory will also try to build the module.

Testing
-------

To run the test scripts run 'make test'.  The tests verify that the results of
the Python version are identical to the results of the compiled version.

Running 'make test' in the top level directory will also try to run the tests
for the Python module.

Installation
------------

To install the Python module run 'make install'.  The installation directory is
the one defined in 'Makefile.conf'.

Running 'make install' in the top level directory will also try to install the
module.

Using - Router
--------------

To use the Python module normally it must be installed and the libroutino
library must also be installed in a directory that is searched for libraries.

The Python example router 'router.py' accepts the same command line arguments as
the compiled versions.

The Python module supports exactly the same functionality as the Routino library
(libroutino) because it is implemented simply as a wrapper around that library.
The documentation for using the library (and therefore the Python module) is
available in the files "doc/LIBRARY.txt" and "doc/html/library.html".

Using - Database
----------------

To use the Python module normally it must be installed, the libroutino library
is not required for the database access functions.

The Python script database.py' is an example of using the Python module for
accessing a Routino database (one created by 'make test').  No further
documentation is provided, all possible features are used in the example script.
1	ROUTINO PYTHON
2	==============
3
4	This directory contains a Python version 3 interface to the Routino routing
5	database that allows routes to be calculated and the database to be accessed.
6
7	Compilation
8	-----------
9
10	To compile the Python module run 'make'. A working Python 3 installation and
11	the Swig tool are required to be able to compile this Python module. If they
12	are not available then a warning will be printed but no error occur.
13
14	Running 'make' in the top level directory will also try to build the module.
15
16	Testing
17	-------
18
19	To run the test scripts run 'make test'. The tests verify that the results of
20	the Python version are identical to the results of the compiled version.
21
22	Running 'make test' in the top level directory will also try to run the tests
23	for the Python module.
24
25	Installation
26	------------
27
28	To install the Python module run 'make install'. The installation directory is
29	the one defined in 'Makefile.conf'.
30
31	Running 'make install' in the top level directory will also try to install the
32	module.
33
34	Using - Router
35	--------------
36
37	To use the Python module normally it must be installed and the libroutino
38	library must also be installed in a directory that is searched for libraries.
39
40	The Python example router 'router.py' accepts the same command line arguments as
41	the compiled versions.
42
43	The Python module supports exactly the same functionality as the Routino library
44	(libroutino) because it is implemented simply as a wrapper around that library.
45	The documentation for using the library (and therefore the Python module) is
46	available in the files "doc/LIBRARY.txt" and "doc/html/library.html".
47
48	Using - Database
49	----------------
50
51	To use the Python module normally it must be installed, the libroutino library
52	is not required for the database access functions.
53
54	The Python script database.py' is an example of using the Python module for
55	accessing a Routino database (one created by 'make test'). No further
56	documentation is provided, all possible features are used in the example script.