# Installation

This part of the documentation covers the installation of Supervisely SDK for Python. The first step to using any software package is getting it properly installed.

## Prerequisites

### Python

You should use 🐍 **Python 3.8 or greater**, which can be installed either through the [Anaconda](https://www.anaconda.com/products/distribution) package manager, [Homebrew](https://brew.sh/), or the [Python website](https://www.python.org/downloads/mac-osx/).

### Libraries

```bash
apt-get update
apt-get install ffmpeg libgeos-dev libsm6 libxext6 libexiv2-dev libxrender-dev libboost-all-dev -y
```

## Installation

If you're working with a custom Supervisely instance, please refer to the compatibility table below to ensure that you're using the correct version of the Python SDK, which supports your instance.\
Note: the latest version of the SDK always supports the latest version of Supervisely, so it's recommended to upgrade both from time to time.

### Compatibility table

| Instance version |   Python SDK version  |
| :--------------: | :-------------------: |
|     >=6.14.4     | supervisely>=6.73.410 |
|     >=6.14.0     | supervisely>=6.73.400 |
|     >=6.13.8     | supervisely>=6.73.394 |
|     >=6.13.1     | supervisely>=6.73.379 |
|     >=6.12.46    | supervisely>=6.73.375 |
|     >=6.12.44    | supervisely>=6.73.344 |
|     >=6.12.34    | supervisely>=6.73.324 |
|     >=6.12.30    | supervisely>=6.73.312 |
|     >=6.12.28    | supervisely>=6.73.292 |
|     >=6.12.23    | supervisely>=6.73.281 |
|     >=6.12.17    | supervisely>=6.73.263 |
|     >=6.12.12    | supervisely>=6.73.241 |
|     >=6.12.5     | supervisely>=6.73.226 |
|     >=6.12.2     | supervisely>=6.73.222 |
|     <=6.11.19    | supervisely>=6.73.199 |
|     <=6.11.16    | supervisely>=6.73.184 |
|     <=6.11.10    | supervisely<=6.73.166 |
|     <=6.11.8     | supervisely<=6.73.159 |
|     <=6.10.0     | supervisely<=6.73.126 |
|     <=6.9.31     | supervisely<=6.73.123 |
|     <=6.9.22     |  supervisely<=6.73.90 |
|     <=6.9.18     |  supervisely<=6.73.81 |
|     <=6.9.13     |  supervisely<=6.73.76 |
|     <=6.9.11     |  supervisely<=6.72.70 |

### Pip

The latest stable version [is available on PyPI](https://pypi.org/project/supervisely/). Either add `supervisely` to your `requirements.txt` file or install with pip:

```bash
pip3 install supervisely
```

To install a specific version, use the following command:

```bash
pip3 install supervisely==6.73.126 # Remember to replace 6.73.126 with the version you need.
```

We are constantly updating our SDK by adding new features and fixing bugs. So if it is already installed on your dev environment, use the installation command with `--upgrade` flag:

```bash
pip3 install --upgrade supervisely
```

### Source code

Supervisely is actively developed on GitHub, where the code is [always available](https://github.com/supervisely/supervisely).

You can either clone the public repository:

```bash
git clone https://github.com/supervisely/supervisely.git
```

Or, download the [zipball](https://github.com/supervisely/supervisely/archive/refs/heads/master.zip):

```bash
$ curl -OL https://github.com/supervisely/supervisely/archive/refs/heads/master.zip
```

Once you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:

```bash
unzip master.zip
cd supervisely-master
python3 -m pip3 install .
```

## VENV

Here is a tiny bash script, that you can place at the root of your repository (for example `create_venv.sh`). It creates [venv](https://docs.python.org/3/library/venv.html) - “virtual” isolated Python installation and installs packages into that virtual installation. When you switch projects, you can simply create a new virtual environment and not have to worry about breaking the packages installed in the other environments. It is always recommended to use a virtual environment while developing Python applications.

```bash
#!/bin/bash

# learn more in documentation
# Official python docs: https://docs.python.org/3/library/venv.html

if [ -d ".venv" ]; then
    echo "VENV already exists, will be removed"
    rm -rf .venv
fi

echo "VENV will be created" && \
python3 -m venv .venv && \
source .venv/bin/activate && \

echo "Install requirements..." && \
pip3 install -r requirements.txt && \
echo "Requirements have been successfully installed" && \
deactivate
```

## Docker image

Supervisely SDK for python also has prebuilt [docker image](https://hub.docker.com/r/supervisely/base-py-sdk) with everything already installed.

You can use the latest version

```bash
docker pull supervisely/base-py-sdk:latest
```

or some specific on that has completely the same tag as [PIP releases](https://pypi.org/project/supervisely/), for example:

```bash
docker pull supervisely/base-py-sdk:6.33.0
```

Here are the links to dockerfiles ([base image](https://github.com/supervisely/supervisely/blob/master/base_images/py/Dockerfile), [result image](https://github.com/supervisely/supervisely/blob/master/base_images/py_sdk/Dockerfile)) where you can find the complete list of all recommended dependencies.