To install and use the HILSTER Testing Framework, a recent version of either CPython 3.5 or later or CPython 2.7 is required.

htf is tested on Microsoft Windows and Canonical Ubuntu Linux operation systems on both x86 and x86-64 architectures. Other operation systems and architectures may be supported.

For further information regarding the support of your specific project requirements please contact us via Mail.

Installation on Windows

If Python is not already installed, please download and install Python using the official CPython installers or use a CPython distribution of your choice, e.g. WinPython.

It is recommended to install Python in the typical paths, e.g. C:\Python36\ or C:\Python27\ for Python 3.6 and Python 2.7 respectively.

If you want to install htf via pip, you need to add the Scripts folder of the Python distribution to your %PATH% environment variable. pip is shipped with recent Python Windows distributions.

Installation on Linux

On most Linux distributions at least on version of Python should already be installed.

On Ubuntu, you can install Python 2.7 and Python 3.5 or later via the apt package manager using the package names python2 and python3, respectively.

Python development packages are required for the installation of htf on Linux. On Ubuntu, install the packages python-dev or python3-dev for Python 2.7 or Python 3.6, respectively.

pip can be installed by installing the packages python-pip or python3-pip for Python 2.7 or Python 3.5, respectively.

For pycrypto, libssl-dev is required.

On Ubuntu, all dependencies should be satisfied using:

sudo apt-get install python2 python3 python-dev python3-dev python-pip python3-pip libssl-dev

Installation in a virtual environment

It is generally recommended to separate project dependencies into different virtual environments.

More information about setting up and using virtual environments on Linux can be found in the python-guide and for Windows in the virtualenv userguide.

It is recommended to use the package virtualenvwrapper, which provides functions that allow for a convenient handling of virtual environments. Further information can be found here.

Installation of htf via pip

Given that Python is properly set up and the virtual environment of your choice is activated, you can simply install htf using pip:

pip install -i htf

Herein -i htf adds the HILSTER python package repository to the search index of pip so that the HILSTER packages can be discovered.

Installation behind a corporate proxy

If you are behind a corporate proxy, there are several ways to tell pip about the proxy url and your credentials.

The simplest solution is to just use the --proxy argument

pip install -i --proxy=http://<username>:<password>@<host>:<port> htf

If you want to persist the proxy settings, it is recommended to store them in the pip configuration file pip.ini, which is stored in the pip folder in your home directory.

proxy = http://<username>:<password>@<host>:<port>

Another solution is use the environment variables https_proxy and http_proxy.

On Linux enter:

export https_proxy=https://<username>:<password>@<host>:<port>
export http_proxy=http://<username>:<password>@<host>:<port>

and on Windows enter:

set https_proxy=https://<username>:<password>@<host>:<port>
set http_proxy=http://<username>:<password>@<host>:<port>

and continue with the installation without the --proxy option.

Check installation

python -c "import hlm"
python -c "import htf"
python -c "import oser"

If the program quits quietly you’re done. If you need to obtain a license read further.


To upgrade add the -U option:

pip install -i -U htf

If you are using a proxy you must add the --proxy option or set environment variables like described above.

Installing a specific version

To install a specific version use

pip install -i htf==1.0.0

for example.

If you are using a proxy you must add the --proxy option or set environment variables like described above.