Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

22 lines (15 loc) · 1.02 KB
Raw

Contributing to alluxio-py

Thanks for your interest in alluxio-py. The project is to enable data access to Alluxio in Python.

Getting Started

We recommend you follow the readme first to get familiar with the project. Contributors would need to install the Python library and dependencies.

Code Style

The project leverages Black as the code formatter and reorder-python-imports to format imports. Black defaults to 88 characters per line (10% over 80), while this project still uses 80 characters per line. We recommend running the following commands before submitting pull requests.

black [changed-file].py --line-length 79
reorder-python-imports [changed-file].py

Testing

The testing framework supports using your Alluxio endpoint, by setting the “ALLUXIO_URL” environment variable(ex. http://127.0.0.1:28080). If this is not set, then an alluxio worker will be spun up using docker and alluxio docker image.