Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,40 @@ This library provides a Pythonic API wrapper for the reference Arrow C++
implementation, along with tools for interoperability with pandas, NumPy, and
other traditional Python scientific computing packages.

#### Development details
### Development details

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++
and pyarrow to pure Python users
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. **Parquet-cpp**

The preferred way to install parquet-cpp is to use conda.
You need to set the ``PARQUET_HOME`` environment variable to where parquet-cpp is installed.
```bash
conda install -y --channel apache/channel/dev parquet-cpp
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is OK for now. I'd like to get this into conda-forge as soon as possible to build from a shared compiler toolchain vs. the current gcc 4.9 dev builds

```
5. **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. Alternatively you could just install arrow-cpp
from conda.
```bash
conda install arrow-cpp -c apache/channel/dev
```
6. **Python dependencies: numpy, pandas, cython, pytest**

#### Install pyarrow
```bash
python setup.py build_ext --inplace
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only instructions here should be to state the build requirements (we may need to update requirements.txt) and the final shell statement.