wormtable 0.1.0b1

Quick install for Debian/Ubuntu

If you are running Debian or Ubuntu, this should get you up and running quickly:

$ sudo apt-get install python-dev libdb-dev
$ sudo pip install wormtable

For Python 3, use python3-dev and pip3.

General instructions

Once Berkeley DB has been installed (see below) we can build the wormtable module using the standard Python methods. For example, using pip we have

$ sudo pip install wormtable

Or, we can manually download the package, unpack it and then run:

$ python setup.py build
$ sudo python setup.py install

Most of the time this will compile and install the module without difficulty.

It is also possible to download the latest development version of wormtable from github.

Python 2.6/3.1

Wormtable requires the argparse package, which was introduced to the standard library for version 3.2 (it is also included in 2.7). For users of older Python versions, the argparse module must be installed for the command line utilities to work:

$ sudo pip install argparse

This is not necessary for recent versions of Python.

Linux

Installing Berkeley DB is very easy on Linux distributions.

On Debian/Ubuntu use:

$ sudo apt-get install libdb-dev

and on Red Hat/Fedora use:

# yum install db4-devel

Other distributions and package managers should provide a similarly easy option to install the DB development files.

Mac OS X

Berkeley DB can be installed from source on a mac, via macports or homebrew.

For MacPorts, to install e.g. v5.3

$ sudo port install db53

for more details of Berkely DB versions, see here: https://www.macports.org/ports.php?by=category&substr=databases

Assuming Berkeley DB is installed with macports then we need to set the CFLAGS and LDFLAGS environment variables to use the headers and libraries in /opt:

$ CFLAGS=-I/opt/local/include/db53 LDFLAGS=-L/opt/local/lib/db53/ python setup.py build
$ sudo python setup.py install

Other Platforms

On platforms that Berkeley DB is not available as part of the native packaging system (or DB was installed locally because of non-root access) there can be issues with finding the correct headers and libraries when compiling wormtable. For example, if we add the DB 4.8 package using:

# pkg_add -r db48

we get the following errors when we try to install wormtable:

$ python setup.py build
... [Messages cut for brevity] ...
_wormtablemodule.c:3727: error: 'DB_NEXT_NODUP' undeclared (first use in this function)
_wormtablemodule.c:3733: error: 'DB_NOTFOUND' undeclared (first use in this function)
_wormtablemodule.c:3739: error: 'DistinctValueIterator' has no member named 'cursor'
_wormtablemodule.c:3739: error: 'DistinctValueIterator' has no member named 'cursor'
_wormtablemodule.c:3740: error: 'DistinctValueIterator' has no member named 'cursor'
error: command 'cc' failed with exit status 1

This is because the compiler does not know where to find the headers and library files for Berkeley DB. To remedy this we must set the LDFLAGS and CFLAGS environment variables to their correct values. Unfortunately there is no simple method to do this and some knowledge of where your system keeps headers and libraries is needed. To complete the installation for the FreeBSD example above, we can do the following:

$ CFLAGS=-I/usr/local/include/db48 LDFLAGS=-L/usr/local/lib/db48 python setup.py build
$ sudo python setup.py install

Tested platforms

Wormtable is higly portable, and has been successfully built and tested on the following platforms: