# API Client for Python Installation

# Requirements

The Cytomine API client for Python library is compatible with Python 3.8+.

The way to install Python depends on your OS or Linux distribution. For Windows and MacOS, get the installers on the Python.org official website (opens new window).

For Linux, python is available with your package manager. For example, on Ubuntu and any debian-based linux distributions, you can install Python and its package manager (pip) with:

sudo apt-get install python3 python3-pip

# Install as a package

To install the package using pip:

pip install cytomine-python-client

The Cytomine API client for the latest release is now installed. See API Client for Python usage to getting started.

# Install from source

# Install dependencies

The Cytomine API client for Python requires some other Python libraries that need to be installed before the client. To install these dependencies, run:

pip install requests requests-toolbelt cachecontrol six future shapely numpy opencv-python-headless

# Download the source code

The Cytomine API client for Python is part of the Cytomine repository (opens new window), in the clients/python folder. To get the source code, clone the repository:

git clone https://github.com/cytomine/cytomine.git

Alternatively, on the repository page, click Code, then Download ZIP and extract the downloaded archive.

# Install the Cytomine Python client

In the clients/python folder of the repository, run:

pip install .

The Cytomine API client for Python last release is now installed. See API Client for Python usage to getting started.

← Cytomine is RESTful Usage →