February 16, 2025
+ 12
Installation instructions for the Python Columnar SDK.

Before You Start

Sign up for a Capella account, and choose a Columnar cluster.

Prerequisites

Currently Python 3.9 - Python 3.12 is supported. See the compatibility page for more information about platform support.

Getting the SDK

The SDK can be installed via npm:

console
python -m pip install couchbase-columnar

Other Installation Methods

A select set of wheels is available on the GitHub Releases page. If a wheel is not available for your specific Python version and/or platform, See the GitHub Building page for details on how to build the SDK’s binary.

Installing from a Downloaded Package

To install the SDK from a wheel on the GitHub Releases page:

  1. Download the appropriate wheel

  2. Unzip the downloaded file

  3. Install via pip: python3 -m pip install <path to unzipped wheel>

Building from Source

If a compatible wheel is not available, the SDK’s binary will need to be built from source:

  • Follow the steps on the GitHub Building page.

  • After the build succeeds, the SDK can be used by running Python scripts from within the cloned repository — or the SDK can be installed via pip: python3 -m pip install <path to cloned repository>