Skip to content

Commit

Permalink
feat: add sdk dev guide (#131)
Browse files Browse the repository at this point in the history
  • Loading branch information
jiacai2050 authored Jun 19, 2024
1 parent 9e27e37 commit 8368f0d
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/src/en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
- [Supported Platform](dev/platform.md)
- [Compile and Running](dev/compile_run.md)
- [Profile](dev/profiling.md)
- [SDK Development](dev/sdk_develop.md)
- [Conventional Commit](dev/conventional_commit.md)
- [Style guide](dev/style_guide.md)
- [Roadmap](dev/roadmap.md)
Expand Down
48 changes: 48 additions & 0 deletions docs/src/en/dev/sdk_develop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Rust

```bash
git clone https://github.com/apache/horaedb-client-rs

cargo build
```

# Python

## Requirements

- python 3.7+

The Python SDK rely on Rust SDK, so [cargo](https://doc.rust-lang.org/stable/cargo/getting-started/installation.html) is also required, then install build tool [maturin](https://github.com/PyO3/maturin):

```bash
pip install maturin
```

Then we can build Python SDK:

```bash
git clone https://github.com/apache/horaedb-client-py

maturin build
```

# Go

```bash
git clone https://github.com/apache/horaedb-client-go

go build ./...
```

# Java

## Requirements

- java 1.8
- maven 3.6.3+

```bash
git clone https://github.com/apache/horaedb-client-java

mvn clean install -DskipTests=true -Dmaven.javadoc.skip=true -B -V
```

0 comments on commit 8368f0d

Please sign in to comment.