Skip to main content
Version: 0.13

Development

How to build Apache Fory™​

Please checkout the source tree from https://github.com/apache/fory.

Build Apache Fory™ Java​

cd java
mvn clean compile -DskipTests

Environment Requirements​

  • java 1.8+
  • maven 3.6.3+

Build Apache Fory™ Python​

cd python
# Uninstall numpy first so that when we install pyarrow, it will install the correct numpy version automatically.
# For Python versions less than 3.13, numpy 2 is not currently supported.
pip uninstall -y numpy
# Install necessary environment for Python < 3.13.
pip install pyarrow==15.0.0 Cython wheel pytest
# For Python 3.13, pyarrow 18.0.0 is available and requires numpy version greater than 2.
# pip install pyarrow==18.0.0 Cython wheel pytest
pip install -v -e .

Environment Requirements​

  • python 3.6+

Build Apache Fory™ C++​

Build fory row format：

pip install pyarrow==15.0.0
bazel build //cpp/fory/row:fory_row_format

Build fory row format encoder:

pip install pyarrow==15.0.0
bazel build //cpp/fory/encoder:fory_encoder

Environment Requirements​

  • compilers with C++17 support
  • bazel 6.3.2

Build Apache Fory™ GoLang​

cd go/fory
# run test
go test -v
# run xlang test
go test -v fory_xlang_test.go

Environment Requirements​

  • go 1.13+

Build Apache Fory™ Rust​

cd rust
# build
cargo build
# run test
cargo test
# run specific test
cargo test -p tests  --test $test_file $test_method
# run specific test under subdirectory
cargo test --test mod $dir$::$test_file::$test_method
# debug specific test under subdirectory and get backtrace
RUST_BACKTRACE=1 FORY_PANIC_ON_ERROR=1 cargo test --test mod $dir$::$test_file::$test_method
# inspect generated code by fory derive macro
cargo expand --test mod $mod$::$file$ > expanded.rs

Environment Requirements​

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Build Apache Fory™ JavaScript​

cd javascript
npm install

# run build
npm run build
# run test
npm run test

Environment Requirements​

  • node 14+
  • npm 8+

Lint Markdown Docs​

# Install prettier globally
npm install -g prettier

# Fix markdown files
prettier --write "**/*.md"

Environment Requirements​

  • node 14+
  • npm 8+

Contributing​

For more information, please refer to How to contribute to Apache Fory™.