Skip to content

Latest commit

 

History

History
140 lines (84 loc) · 4 KB

BUILD.md

File metadata and controls

140 lines (84 loc) · 4 KB
Raw

Manually Building the Python Client for Aerospike

Dependencies

The Python client for Aerospike works with Python 2.6, 2.7, 3.4, 3.5 running on 64-bit OS X 10.9+ and Linux.

The client depends on:

  • The Python devel package
  • OpenSSL
  • The Aerospike C client

RedHat 6+ and CentOS 6+

The following are dependencies for:

  • RedHat Enterprise (RHEL) 6 or newer
  • CentOS 6 or newer
  • Related distributions which use the yum package manager
sudo yum install openssl-devel
sudo yum install python26-devel # on CentOS 6 and similar
sudo yum install python-devel # on CentOS 7

To get python26-devel on older distros such as CentOS 5, see Stack Overflow.

Debian 6+ and Ubuntu 12.04+

The following are dependencies for:

  • Debian 6 or newer
  • Ubuntu 12.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

OS X

By default OS X will be missing command line tools. On Mavericks (OS X 10.9) and higher those can be installed without Xcode.

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

The dependencies can be installed through the OS X package manager Homebrew.

brew install openssl

Build

To build the library:

python setup.py build --force

The helper scripts/aerospike-client-c.sh is triggered by setup.py to download the appropriate C client. However, if one is present this will not happen, and a build may fail against an old client. At that point you should remove the directory aerospike-client-c and run the build command again.

Building on an Unsupported Linux Distro

If you are installing the Python client on an unsupported OS, such as CentOS 5, you will need to first build the C client manually.

  1. Clone the aerospike/aerospike-client-c repo from GitHub.
  2. Install the dependencies. See the README.
  3. Change directory to the C client, and build it.
git submodule update --init
make
  1. Clone the aerospike/aerospike-lua-core repo from GitHub.
  2. Change directory to the Python client and build it.
export DOWNLOAD_C_CLIENT=0
export AEROSPIKE_C_HOME=/path/to/aerospike-c-client
export AEROSPIKE_LUA_PATH=/path/to/aerospike-lua-core/src
python setup.py build --force

Install

To install the library:

python setup.py install --force

Lua System Modules

Stream UDF functionality requires a local copy of the system Lua modules. By default, those Lua files are copied to /usr/local/aerospike/lua. A different directory can be created, then set:

python setup.py install --lua-system-path=/path/to/lua

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.