Installation, Activation and Upgrading¶
To install HILSTER Testing Framework, a recent version of either CPython 3 or later or CPython 2.7 is required. We suggest to use CPython 3.8 64 bit, since Python 2.7 is discontinued since January 2020.
htf is tested on Microsoft Windows and all Linux versions that support
Wheels for Python 3 on Linux are shipped in
Wheels for Python 2.7 on Linux are shipped in
We host our own pypi server.
For further information regarding the support of your specific project requirements, please contact contact our Support.
Installation on Windows¶
It is recommended to install Python in the typical paths, e.g.
C:\Python27\ for Python 3.8 and Python 2.7 respectively.
If you want to install
pip, you need to add the
Scripts folder of the Python distribution to your
%PATH% environment variable (there is an option in the installer).
pip is shipped with recent Python Windows distributions.
Installation on Linux¶
On most Linux distributions, at least one version of Python should be installed by default. Since 2020, this version should be Python 3.
pip can be installed by installing the packages
python3-pip for Python 2.7
or Python 3.8, respectively. There are no other dependencies that need to be installed on Linux.
On Ubuntu for example, all dependencies should be satisfied using:
sudo apt install python3-pip
Installation in a virtual environment¶
It is generally recommended to separate project dependencies into different virtual environments.
It is recommended to use the
virtualenvwrapper package, which provides functions that allow for a
convenient handling of virtual environments.
Further information can be found in the virtualenwrapper docs.
There is also a Windows port called virtualenvwrapper-win.
Installation using Anaconda¶
Alternatively Anaconda can be used as a multi-platform Python-Platform. Installers for Windows and Linux are provided by Anaconda. It is pre-packaged with multiple libraries especially from the data science community. Before moving on please download and install Anaconda on your system.
After the base install it is again recommended to separate project dependencies into different
You can create a
conda environment using the Anaconda Prompt:
conda create --name environment_name python conda activate environment_name
Further references to the Anaconda Prompt can be found in the Anaconda docs.
You can then proceed to install
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 https://pypi.hilster.io htf
To install the community-version accordingly, run
pip install -i https://pypi.hilster.io htf-community
-i https://pypi.hilster.io adds the HILSTER python package repository to the search
index of pip so that the HILSTER packages can be discovered.
Depending on your installation, you might have to replace
Installation behind a corporate proxy¶
If you are behind a corporate proxy, there are several ways to tell
pip about the proxy url and
The simplest solution is to just use the
pip install -i https://pypi.hilster.io --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
pip.ini, which is stored in the
pip folder in your home directory.
[global] proxy = http://<username>:<password>@<host>:<port>
Another solution is use the environment variable
On Linux enter:
and on Windows enter:
and continue with the installation without the
HILSTER’s license server is used for remote activation.
Activation is not needed if you use the community edition, since a license is already included.
To activate non-community versions of the software, you need one or more activation keys that HILSTER sent you.
An activation key consists of
16 upper case letters in
concatenated by dashes.
hlm activate ABCD-EFGH-IJKL-MNOP
You can also activate more then one activation key at a time.
hlm activate ABCD-EFGH-IJKL-MNOP QRST-UVWX-YZAB-CDEF # ...
Activation creates a license that is stored locally.
To renew the licenses once activated, simply run
When you are behind a proxy, you have to set the environment variable
https_proxy like in the installation process.
Every virtual environment has to be activated separately.
To list your licenses, run
If htf prints a version, it is unlockable
htf version # prints the version
To upgrade add the
pip install -i https://pypi.hilster.io -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 https://pypi.hilster.io htf==2.0.0
If you are using a proxy you must add the
--proxy option or set environment variables like described