Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
137 lines (100 loc) · 2.61 KB

DEVELOPMENT.md

File metadata and controls

137 lines (100 loc) · 2.61 KB
title Development
sidebar_position 7
id development
license Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

How to build Fory

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

Build Fory Java

cd java
mvn clean compile -DskipTests

Environment Requirements

  • java 1.8+
  • maven 3.6.3+

Build 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 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 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 Fory Rust

cd rust
# build
cargo build
# run test
cargo test

Environment Requirements

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

Build 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+