Skip to content

Installing Ximilar Client


We have our own SDK client written in Python3.9+ (recommended). Before installing it, be sure to install Python on your system first. You will need to have also a pip tools. You can optionally install the client directly from the repository.

Basic Installation Command

If you have all the prerequisities (python, opencv), the installation can be performed in two ways:

pip install ximilar-client

or manual installation from repository (with latest changes):

git clone
pip install -e ximilar-client

On some systems you will need to write pip3 install ximilar-client instead of just pip.

Installing prerequisities

Installing pip and python


For mac systems, pip should be part of brew package. Just be sure to install homebrew ( and run following command:

brew install python3


Here are commands for the most popular ubuntu version (python should be already installed)

sudo apt update
sudo apt install python3-pip


Installing python and opencv is nicely described on this youtube video. Basically you need to download and install python from

Installing Opencv-Python


The most easiest way to install python opencv is via pip again:

pip install opencv-python

You can optionally install opencv-python-contrib, opencv-python-headless or opencv-python-contrib-headless. Headless versions are suitable for server usage with no graphical interface.

Pip - pick package

Sometimes your pip system will not install correct opencv version. On my Mac M2 (arm), I must find a correct package on pypi and then install it.

  1. Find correct version on
  2. Go to the version (for example and click on Download files in the left menu. Then pick your distribution, in my case it was opencv_contrib_python- which is built for arm(m1/m2/...) processors.
  3. Run pip or pip3 on downloaded whl package: pip install your-downloaded-opencv-whl-package.whl

Install from

Alternatively, you can try to install opencv directly from their page:

Building from source

The hardest way to install, however on some platforms necessary. This is the last option, for example here is tutorial for Jetson Nano:

Here is way for installing opencv on M1 Macbooks:

Testing installation

After installing opencv (go to python command line) by writting python or python3 in terminal/shell and test following code:

import cv2