Installation¶

Requirements¶

Requirement	Minimum Version
Python	3.9+
pip	21.0+
Operating System	Linux, macOS, Windows

Install via pip¶

pip install cloudsync-sdk

With optional dependencies¶

# PostgreSQL adapter
pip install cloudsync-sdk[postgres]

# Redis adapter
pip install cloudsync-sdk[redis]

# gRPC transport
pip install cloudsync-sdk[grpc]

# All extras
pip install cloudsync-sdk[all]

Install from source¶

git clone https://github.com/cloudsync/cloudsync-sdk.git
cd cloudsync-sdk
pip install -e ".[dev]"

Verify installation¶

python -c "import cloudsync; print(cloudsync.__version__)"
# Expected output: 3.4.2

Docker¶

Official Docker images are published to Docker Hub:

docker pull cloudsync/sdk:3.4.2
docker run --rm cloudsync/sdk:3.4.2 python -c "import cloudsync; print(cloudsync.__version__)"

Platform-Specific Notes¶

macOSLinuxWindows

On Apple Silicon (M1/M2/M3), the native ARM wheel is used automatically. No Rosetta required.

brew install python@3.12
pip install cloudsync-sdk

Manylinux2014 wheels are provided for x86_64 and aarch64.

# Debian/Ubuntu
sudo apt install python3-dev python3-pip
pip install cloudsync-sdk

# Arch Linux
sudo pacman -S python python-pip
pip install cloudsync-sdk

Requires Visual C++ Redistributable 2019 or later.

pip install cloudsync-sdk

Python 3.8 End of Life

Support for Python 3.8 was dropped in CloudSync SDK v3.3.0. Please upgrade to Python 3.9 or later.

Next: Quick Start →