Skip to content

Latest commit

 

History

History
131 lines (85 loc) · 4.44 KB

BUILD.md

File metadata and controls

131 lines (85 loc) · 4.44 KB
Raw

Manually Building the Python Client for Aerospike

The Python client for Aerospike works with Python 3.6, 3.7, 3.8, 3.9 running on 64-bit macOS 10.15+ and Linux. Python 3.6 hits End of Life on December 23rd, 2021, and is now deprecated.

First clone this repository to get the necessary files.

git clone --recurse-submodules ...

or to initialize the submodules after cloning

git submodule update --init --checkout --recursive

Dependencies

The client depends on:

  • The Python devel package
  • OpenSSL 1.1 >= 1.1.1
  • The Aerospike C client

RedHat 7+ and CentOS 7+

The following are dependencies for:

  • RedHat Enterprise (RHEL) 7 or newer
  • CentOS 7 or newer
  • Related distributions which use the yum package manager
sudo yum install openssl-devel
sudo yum install python-devel # on CentOS 7
# Possibly needed
sudo yum install python-setuptools

Debian 8+ and Ubuntu 18.04+

The following are dependencies for:

  • Debian 8 or newer
  • Ubuntu 18.04 or newer
  • Related distributions which use the apt package manager
sudo apt-get install libssl-dev
sudo apt-get install build-essential python-dev

macOS

By default macOS will be missing command line tools.

xcode-select --install # install the command line tools, if missing

The dependencies can be installed through the macOS package manager Homebrew.

brew install openssl@1
# brew uninstall openssl@3

Build

export DOWNLOAD_C_CLIENT=0
export AEROSPIKE_C_HOME=$(pwd)/aerospike-client-c
export STATIC_SSL=1
# substitute the paths to your OpenSSL 1.1 library
export SSL_LIB_PATH=/usr/local/Cellar/[email protected]/1.1.1l/lib/
export CPATH=/usr/local/Cellar/[email protected]/1.1.1l/include/
python setup.py build --force

Troubleshooting macOS

In some versions of macOS, Python 2.7 is installed as python with pip as its associated package manager, and Python 3 is installed as python3 with pip3 as the associated package manager. Make sure to use the ones that map to Python 3, such as python3 setup.py build --force.

Building on macOS versions >= 10.15 , may cause a few additional errors to be generated. If the build command fails with an error similar to: error: could not create '/usr/local/aerospike/lua': Permission denied there are a couple of options:

  • Rerun the build command with the additional command line flags --user --prefix= Note that there are no charcters after the '='. This will cause the library to only be installed for the current user, and store the library's data files in a user specific location.
  • rerun the command with sudo.

If an error similar to ld: targeted OS version does not support use of thread local variables appears, it can be fixed by temporarily setting the MACOSX_DEPLOYMENT_TARGET environment variable to '10.12' e.g.

MACOSX_DEPLOYMENT_TARGET=10.12 python setup.py build --force
MACOSX_DEPLOYMENT_TARGET=10.12 python setup.py install --force

Install

Once the client is built:

python setup.py install --force

Troubleshooting macOS

  • Rerun the install command with the additional command line flags --user --prefix= Note that there are no charcters after the '='. This will cause the library to only be installed for the current user, and store the library's data files in a user specific location.
  • rerun the command with sudo.

Examples

Note If you did not install the library, then you will need to setup your PYTHONPATH environment variable. The PYTHONPATH should contain an entry for the directory where the Python module is stored. This is usually in build/lib.*.

Examples are in the examples directory. The following examples are available:

  • kvs.py — Key-Value Store API Example
  • query.py — Query API Example
  • scan.py — Scan API Example
  • info.py — Info API Example
  • simple.lua — Simple UDF Example

Each example provides help/usage information when you specify the --help option. For example, for help on the kvs.py example, then run:

python examples/client/kvs.py --help

Running Examples

Simply call python with the path to the example

python examples/client/kvs.py

License

The Aerospike Python Client is made availabled under the terms of the Apache License, Version 2, as stated in the file LICENSE.

Individual files may be made available under their own specific license, all compatible with Apache License, Version 2. Please see individual files for details.