From 9c5da8504a5232f5e2cecb1b8ae94d1e4769785f Mon Sep 17 00:00:00 2001 From: jiacai2050 Date: Tue, 10 Dec 2024 10:52:24 +0800 Subject: [PATCH 1/3] feat: add python client --- .gitignore | 1 + content/cn/docs/user-guide/sdk/python.md | 6 ++--- content/cn/docs/user-guide/sdk/rust.md | 4 +-- content/en/docs/user-guide/sdk/python.md | 12 +++++---- content/en/docs/user-guide/sdk/rust.md | 2 ++ content/en/downloads.md | 31 ++++++++++++++++++------ 6 files changed, 39 insertions(+), 17 deletions(-) diff --git a/.gitignore b/.gitignore index 4c95e2ca..fc100349 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ /node_modules package.json package-lock.json +.DS_Store \ No newline at end of file diff --git a/content/cn/docs/user-guide/sdk/python.md b/content/cn/docs/user-guide/sdk/python.md index 93501078..8a483225 100644 --- a/content/cn/docs/user-guide/sdk/python.md +++ b/content/cn/docs/user-guide/sdk/python.md @@ -4,9 +4,9 @@ title: "Python" ## 介绍 -[horaedb-client](https://pypi.org/project/ceresdb-client/) 是 [HoraeDB](https://github.com/apache/incubator-horaedb) python 客户端. +[horaedb-client](https://pypi.org/project/horaedb-client/) 是 [HoraeDB](https://github.com/apache/incubator-horaedb) python 客户端. -借助于 [PyO3](https://github.com/PyO3)，python 客户端的实现实际上是基于 [rust 客户端](https://github.com/apache/incubator-horaedb-client-rs) 的封装。 +借助于 [PyO3](https://github.com/PyO3)，python 客户端的实现实际上是基于 [rust 客户端](https://github.com/apache/horaedb-client-rs) 的封装。 本手册将会介绍 python client 的一些基本用法，其中涉及到的完整示例，可以查看[该示例代码](https://github.com/apache/incubator-horaedb-client-py/blob/main/examples/read_write.py). @@ -17,7 +17,7 @@ title: "Python" ## 安装 ```bash -pip install ceresdb-client +pip install horaedb-client ``` 你可以在这里找到最新的版本 [here](https://github.com/apache/incubator-horaedb-client-py/tags). diff --git a/content/cn/docs/user-guide/sdk/rust.md b/content/cn/docs/user-guide/sdk/rust.md index a8fc4735..6aa682fb 100644 --- a/content/cn/docs/user-guide/sdk/rust.md +++ b/content/cn/docs/user-guide/sdk/rust.md @@ -5,10 +5,10 @@ title: "Rust" ## 安装 ```bash -cargo add ceresdb-client +cargo add horaedb-client ``` -你可以在这里找到最新的版本 [here](https://github.com/apache/incubator-horaedb-client-rs/tags). +你可以在这里找到最新的版本 [here](https://github.com/apache/horaedb-client-rs/tags). ## 初始化客户端 diff --git a/content/en/docs/user-guide/sdk/python.md b/content/en/docs/user-guide/sdk/python.md index 70f98c84..b8b33168 100644 --- a/content/en/docs/user-guide/sdk/python.md +++ b/content/en/docs/user-guide/sdk/python.md @@ -2,13 +2,15 @@ title: "Python" --- +[![](https://img.shields.io/pypi/v/horaedb-client.svg)](https://pypi.org/project/horaedb-client) [![](https://img.shields.io/github/stars/apache/horaedb-client-py)](https://github.com/apache/horaedb-client-py) + ## Introduction -[horaedb-client](https://pypi.org/project/ceresdb-client/) is the python client for [HoraeDB](https://github.com/apache/incubator-horaedb). +[horaedb-client](https://pypi.org/project/horaedb-client/) is the python client for [HoraeDB](https://github.com/apache/horaedb). -Thanks to [PyO3](https://github.com/PyO3), the python client is actually a wrapper on the [rust client](https://github.com/apache/incubator-horaedb-client-rs). +Thanks to [PyO3](https://github.com/PyO3), the python client is actually a wrapper on the [rust client](https://github.com/apache/horaedb-client-rs). -The guide will give a basic introduction to the python client by [example](https://github.com/apache/incubator-horaedb-client-py/blob/main/examples/read_write.py). +The guide will give a basic introduction to the python client by [example](https://github.com/apache/horaedb-client-py/blob/main/examples/read_write.py). ## Requirements @@ -17,10 +19,10 @@ The guide will give a basic introduction to the python client by [example](https ## Installation ```bash -pip install ceresdb-client +pip install horaedb-client ``` -You can get latest version [here](https://github.com/apache/incubator-horaedb-client-py/tags). +You can get latest version [here](https://github.com/apache/horaedb-client-py/tags). ## Init HoraeDB Client diff --git a/content/en/docs/user-guide/sdk/rust.md b/content/en/docs/user-guide/sdk/rust.md index eb5af9ae..a631fcf5 100644 --- a/content/en/docs/user-guide/sdk/rust.md +++ b/content/en/docs/user-guide/sdk/rust.md @@ -2,6 +2,8 @@ title: "Rust" --- +[![](https://img.shields.io/crates/v/horaedb-client.svg)](https://crates.io/crates/horaedb-client) [![](https://img.shields.io/github/stars/apache/horaedb-client-rs)](https://github.com/apache/horaedb-client-rs) + ## Install ```bash diff --git a/content/en/downloads.md b/content/en/downloads.md index fb91153e..ab6504ce 100644 --- a/content/en/downloads.md +++ b/content/en/downloads.md @@ -7,32 +7,49 @@ menu: pre: --- -Apache HoraeDB is released as source code tarballs with corresponding docker images for convenience. +## Server +Apache HoraeDB server is released as source code tarballs with corresponding docker images for convenience. -# The latest release +### The latest release The latest release is 2.1.0(2024-11-18), the source code can be downloaded [here](https://downloads.apache.org/incubator/horaedb/horaedb/v2.1.0/apache-horaedb-incubating-v2.1.0-src.tar.gz). Verify this release using the [signatures](https://downloads.apache.org/incubator/horaedb/horaedb/v2.1.0/apache-horaedb-incubating-v2.1.0-src.tar.gz.asc), [checksums](https://downloads.apache.org/incubator/horaedb/horaedb/v2.1.0/apache-horaedb-incubating-v2.1.0-src.tar.gz.sha512) by following guides below. -## Docker images +### Docker images Pre-built binaries are not provided yet, users can [compile from source]({{< ref "compile_run.md" >}}) or using docker images: - https://hub.docker.com/r/apache/horaemeta-server - https://hub.docker.com/r/apache/horaedb-server -## All archived releases +### All archived releases For older releases, please check the [archive](https://downloads.apache.org/incubator/horaedb/horaedb/). -# Verify signatures and checksums +## Client + +### Rust +The latest rust client version is v2.0.0(2024-11-26), source codes can be downloaded [here](https://downloads.apache.org/incubator/horaedb/horaedb-client-rust/v2.0.0/apache-horaedb-incubating-rust-client-v2.0.0-src.tar.gz). + +Verify this release using the [signatures](https://downloads.apache.org/incubator/horaedb/horaedb-client-rust/v2.0.0/apache-horaedb-incubating-rust-client-v2.0.0-src.tar.gz.asc), [checksums](https://downloads.apache.org/incubator/horaedb/horaedb-client-rust/v2.0.0/apache-horaedb-incubating-rust-client-v2.0.0-src.tar.gz.sha512) by following guides below. + +It's also available on [crates.io](https://crates.io/crates/horaedb-client). + +### Python +The latest python client version is v2.0.0(2024-12-10), source codes can be downloaded [here](https://downloads.apache.org/incubator/horaedb/horaedb-client-python/v2.0.0/apache-horaedb-incubating-python-client-v2.0.0-src.tar.gz). + +Verify this release using the [signatures](https://downloads.apache.org/incubator/horaedb/horaedb-client-python/v2.0.0/apache-horaedb-incubating-python-client-v2.0.0-src.tar.gz.asc), [checksums](https://downloads.apache.org/incubator/horaedb/horaedb-client-python/v2.0.0/apache-horaedb-incubating-python-client-v2.0.0-src.tar.gz.sha512) by following guides below. + +It's also available on [pypi.org](https://pypi.org/project/horaedb-client/). + +## Verify signatures and checksums It's highly recommended to verify the files that you download. HoraeDB provides SHA digest and PGP signature files for all the files that we host on the download site. These files are named after the files they relate to but have `sha512`, `asc` extensions. -## Verify Checksums +### Verify Checksums To verify the SHA digests, you need the `tar.gz` and its associated `tar.gz.sha512` files. An example command: @@ -46,7 +63,7 @@ It should output something like: apache-horaedb-incubating-v2.0.0-src.tar.gz: OK ``` -## Verify Signatures +### Verify Signatures To verify the PGP signatures, you will need to download the [release KEYS](https://downloads.apache.org/incubator/horaedb/KEYS) first. From e660845251018a6ed0ecbf5b0296acd6576278fc Mon Sep 17 00:00:00 2001 From: jiacai2050 Date: Tue, 10 Dec 2024 10:54:35 +0800 Subject: [PATCH 2/3] lint --- content/en/downloads.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/en/downloads.md b/content/en/downloads.md index ab6504ce..273fce98 100644 --- a/content/en/downloads.md +++ b/content/en/downloads.md @@ -8,6 +8,7 @@ menu: --- ## Server + Apache HoraeDB server is released as source code tarballs with corresponding docker images for convenience. ### The latest release @@ -30,6 +31,7 @@ For older releases, please check the [archive](https://downloads.apache.org/incu ## Client ### Rust + The latest rust client version is v2.0.0(2024-11-26), source codes can be downloaded [here](https://downloads.apache.org/incubator/horaedb/horaedb-client-rust/v2.0.0/apache-horaedb-incubating-rust-client-v2.0.0-src.tar.gz). Verify this release using the [signatures](https://downloads.apache.org/incubator/horaedb/horaedb-client-rust/v2.0.0/apache-horaedb-incubating-rust-client-v2.0.0-src.tar.gz.asc), [checksums](https://downloads.apache.org/incubator/horaedb/horaedb-client-rust/v2.0.0/apache-horaedb-incubating-rust-client-v2.0.0-src.tar.gz.sha512) by following guides below. @@ -37,6 +39,7 @@ Verify this release using the [signatures](https://downloads.apache.org/incubato It's also available on [crates.io](https://crates.io/crates/horaedb-client). ### Python + The latest python client version is v2.0.0(2024-12-10), source codes can be downloaded [here](https://downloads.apache.org/incubator/horaedb/horaedb-client-python/v2.0.0/apache-horaedb-incubating-python-client-v2.0.0-src.tar.gz). Verify this release using the [signatures](https://downloads.apache.org/incubator/horaedb/horaedb-client-python/v2.0.0/apache-horaedb-incubating-python-client-v2.0.0-src.tar.gz.asc), [checksums](https://downloads.apache.org/incubator/horaedb/horaedb-client-python/v2.0.0/apache-horaedb-incubating-python-client-v2.0.0-src.tar.gz.sha512) by following guides below. From aff143870626fb6effd900f36325a36636cc0e52 Mon Sep 17 00:00:00 2001 From: jiacai2050 Date: Tue, 10 Dec 2024 10:55:48 +0800 Subject: [PATCH 3/3] newline --- content/en/docs/user-guide/sdk/python.md | 3 ++- content/en/docs/user-guide/sdk/rust.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/content/en/docs/user-guide/sdk/python.md b/content/en/docs/user-guide/sdk/python.md index b8b33168..7035370b 100644 --- a/content/en/docs/user-guide/sdk/python.md +++ b/content/en/docs/user-guide/sdk/python.md @@ -2,7 +2,8 @@ title: "Python" --- -[![](https://img.shields.io/pypi/v/horaedb-client.svg)](https://pypi.org/project/horaedb-client) [![](https://img.shields.io/github/stars/apache/horaedb-client-py)](https://github.com/apache/horaedb-client-py) +[![](https://img.shields.io/pypi/v/horaedb-client.svg)](https://pypi.org/project/horaedb-client) +[![](https://img.shields.io/github/stars/apache/horaedb-client-py)](https://github.com/apache/horaedb-client-py) ## Introduction diff --git a/content/en/docs/user-guide/sdk/rust.md b/content/en/docs/user-guide/sdk/rust.md index a631fcf5..37c32668 100644 --- a/content/en/docs/user-guide/sdk/rust.md +++ b/content/en/docs/user-guide/sdk/rust.md @@ -2,7 +2,8 @@ title: "Rust" --- -[![](https://img.shields.io/crates/v/horaedb-client.svg)](https://crates.io/crates/horaedb-client) [![](https://img.shields.io/github/stars/apache/horaedb-client-rs)](https://github.com/apache/horaedb-client-rs) +[![](https://img.shields.io/crates/v/horaedb-client.svg)](https://crates.io/crates/horaedb-client) +[![](https://img.shields.io/github/stars/apache/horaedb-client-rs)](https://github.com/apache/horaedb-client-rs) ## Install