Skip to content

Set up

On this page we explain how to download, install and run Since is available on GitHub, and PyPi, we will show you how to set up the application both ways.


With pip is available on PyPi repository.


You will need python >= 3.6.

You should start with creating a virtual environment by running

py -m venv myvenv
python -m venv myvenv
python -m venv myvenv

which will create a virtual environment named myvenv in your current directory. Once it is created, you can activate it by running


In your virtual environment install via pip manager

py -m pip install dqoai
pip install dqoai
pip install dqoai

and finally run


to download required files from GitHub. Here is what it should look like on Windows with virtual env called dqoai:

(dqoai) C:\dqoai>dqo
Trying to download version 0.1.0 from
Downloaded 1048576 of 223346570 bytes (0.47%)
Downloaded 2097152 of 223346570 bytes (0.94%)
Downloaded 3145728 of 223346570 bytes (1.41%)
Downloaded 222298112 of 223346570 bytes (99.53%)
Downloaded 223346570 of 223346570 bytes (100.00%)
Installing Java JRE 17 at C:\dqoai\Lib\site-packages\dqoai\jre17

Running the same command once again will launch the application. In the first run will ask you if you want to initialize user home at specified directory, and if you want to log in to the dqo cloud (this step is necessary to use cloud commands ).

(dqoai) C:\>dqo
      _                               _
   __| |   __ _    ___         __ _  (_)
  / _` |  / _` |  / _ \       / _` | | |
 | (_| | | (_| | | (_) |  _  | (_| | | |
  \__,_|  \__, |  \___/  (_)  \__,_| |_|

 :: DQO.AI Data Quality Observer ::    (v0.1.0)

Initialize a DQO user home at C:\dqoai\. [Y,n]: y
Log in to DQO Cloud? [Y,n]: y
Opening the DQO Cloud API Key request, please log in or create your DQO Cloud account.
DQO Cloud API Key request may be opened manually by navigating to:
Please wait up to 30 seconds after signup/login or press any key to cancel
API Key: your-key
DQO Cloud API Key was retrieved and stored in the settings.>

From now on you are ready to use

With git


You will need JDK 17. To confirm version run java --version and you should see something similar to this

java --version
openjdk 17.0.2 2022-01-01
you should also confirm that you have a java compiler.
javac --version
javac 17.0.2

If you prefer to work on a source code, you can clone the repository on GitHub

git clone

and run the following command in the app directory


which will start the compilation process and launch

The rest of the process is the same as in pip installation.