Alluxio Python Client

Install

pip install alluxio

Example

See example.py.

Dependencies

• Python 2.7 or later
• requests
• pytest

pip install -r requirements.txt

Install for Development

pip install -e .

Code Style

Follow pep8 for source code style, except the restriction for line width.

Check code style by pep8 --ignore=E501 alluxio/.

Follow Google style for docstrings.

Generate Documentation

pip install 'sphinx<1.4' # the latest sphinx has some format issue in the generated html files
cd docs
make html
# open docs/_build/html/index.html in your browser

Unit Tests

Unit tests are in alluxio/tests directory, they can be run under the alluxio-py directory by

pytest

See the test coverage report by

pytest --cov .

Integration Tests

Integration tests are under the tests directory, see tests/README.md for more details.