You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by we...@apache.org on 2017/03/28 03:13:38 UTC
arrow git commit: ARROW-716: [Python] Update README build
instructions after moving libpyarrow to C++ tree
Repository: arrow
Updated Branches:
refs/heads/master d2d27555b -> e717d4786
ARROW-716: [Python] Update README build instructions after moving libpyarrow to C++ tree
Author: Wes McKinney <we...@twosigma.com>
Closes #445 from wesm/ARROW-716 and squashes the following commits:
2608d2b [Wes McKinney] Update README after moving libpyarrow to main C++ source tree
Project: http://git-wip-us.apache.org/repos/asf/arrow/repo
Commit: http://git-wip-us.apache.org/repos/asf/arrow/commit/e717d478
Tree: http://git-wip-us.apache.org/repos/asf/arrow/tree/e717d478
Diff: http://git-wip-us.apache.org/repos/asf/arrow/diff/e717d478
Branch: refs/heads/master
Commit: e717d47865038a65a23d80d6d5d6df782d9a8e43
Parents: d2d2755
Author: Wes McKinney <we...@twosigma.com>
Authored: Mon Mar 27 23:13:33 2017 -0400
Committer: Wes McKinney <we...@twosigma.com>
Committed: Mon Mar 27 23:13:33 2017 -0400
----------------------------------------------------------------------
cpp/README.md | 10 ++++++++++
python/README.md | 33 +++++++++++++++++++--------------
2 files changed, 29 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/arrow/blob/e717d478/cpp/README.md
----------------------------------------------------------------------
diff --git a/cpp/README.md b/cpp/README.md
index 51f1f06..b6f0fa0 100644
--- a/cpp/README.md
+++ b/cpp/README.md
@@ -81,6 +81,16 @@ variables
* Hadoop: `HADOOP_HOME` (only required for the HDFS I/O extensions)
* jemalloc: `JEMALLOC_HOME` (only required for the jemalloc-based memory pool)
+### Building Python integration library
+
+The `arrow_python` shared library can be built by passing `-DARROW_PYTHON=on`
+to CMake. This must be installed or in your library load path to be able to
+build pyarrow, the Arrow Python bindings.
+
+The Python library must be built against the same Python version for which you
+are building pyarrow, e.g. Python 2.7 or Python 3.6. NumPy must also be
+installed.
+
### API documentation
To generate the (html) API documentation, run the following command in the apidoc
http://git-wip-us.apache.org/repos/asf/arrow/blob/e717d478/python/README.md
----------------------------------------------------------------------
diff --git a/python/README.md b/python/README.md
index 88ab17e..25a3a67 100644
--- a/python/README.md
+++ b/python/README.md
@@ -22,25 +22,30 @@ other traditional Python scientific computing packages.
This project is layered in two pieces:
-* pyarrow, a C++ library for easier interoperability between Arrow C++, NumPy,
- and pandas
-* Cython extensions and pure Python code under arrow/ which expose Arrow C++
+* arrow_python, a library part of the main Arrow C++ project for Python,
+ pandas, and NumPy interoperability
+* Cython extensions and pure Python code under pyarrow/ which expose Arrow C++
and pyarrow to pure Python users
#### PyArrow Dependencies:
-These are the various projects that PyArrow depends on.
-1. **g++ and gcc Version >= 4.8**
-2. **cmake > 2.8.6**
-3. **boost**
-4. **Arrow-cpp and its dependencies**
-
-The Arrow C++ library must be built with all options enabled and installed with
-``ARROW_HOME`` environment variable set to the installation location. Look at
-(https://github.com/apache/arrow/blob/master/cpp/README.md) for instructions.
+To build pyarrow, first build and install Arrow C++ with the Python component
+enabled using `-DARROW_PYTHON=on`, see
+(https://github.com/apache/arrow/blob/master/cpp/README.md) . These components
+must be installed either in the default system location (e.g. `/usr/local`) or
+in a custom `$ARROW_HOME` location.
+
+```shell
+mkdir cpp/build
+pushd cpp/build
+cmake -DARROW_PYTHON=on -DCMAKE_INSTALL_PREFIX=$ARROW_HOME ..
+make -j4
+make install
+```
-Ensure PyArrow can locate the Arrow-cpp shared libraries by setting the
-LD_LIBRARY_PATH environment variable.
+If you build with a custom `CMAKE_INSTALL_PREFIX`, during development, you must
+set `ARROW_HOME` as an environment variable and add it to your
+`LD_LIBRARY_PATH` on Linux and OS X:
```bash
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ARROW_HOME/lib