htsql-sqlascii-patch / doc / admin / install.rst

Installing HTSQL

Binary Packages

We provide binary packages for various Linux platforms.

They are available at

Installing from Source

The following instructions assume a recent Debian or Debian-derived system, but could be easily adapted to other Linux distributions and package managers.


HTSQL requires Python 2.5 or newer, but does not yet support Python 3. Python 2.7 is the recommended version. In most Linux distributions, Python is already installed; if not, install it by running:

# apt-get install python

Installation of Python modules that have no system packages requires the pip package manager:

# apt-get install python-pip

HTSQL needs setuptools and pyyaml libraries:

# apt-get install python-setuptools python-yaml

Furthermore, some database backends require an additional database driver.

  • SQLite requires no additional drivers.

  • For PostgreSQL, install psycopg2:

    # apt-get install python-psycopg2
  • For MySQL, install MySQL-python:

    # apt-get install python-mysqldb
  • For MS SQL Server, install pymssql:

    # apt-get install python-pymssql
  • For Oracle, download and install Oracle Instant Client from, then download, build and install cx_Oracle. The latter could be done with the pip package manager:

    # pip install cx-oracle

Installing HTSQL

Download, build and install HTSQL, either from a source package or from HTSQL source repository.

  • To install the latest released version of HTSQL, use pip:

    # pip install HTSQL
  • To use the latest development version of HTSQL, install Mercurial, download HTSQL source, then build and install HTSQL:

    # apt-get install mercurial
    $ hg clone
    $ cd htsql
    # make install