This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
The following commit(s) were added to refs/heads/master by this push:
new c6a1a36d Initial Writing of Python Client README (#513)
c6a1a36d is described below
commit c6a1a36d4485e9c7cf9064e250d181a4cc868ec0
Author: Yan Chao Mei <[email protected]>
AuthorDate: Thu May 11 18:46:44 2023 +0800
Initial Writing of Python Client README (#513)
* add python client README
* fix python miminal version
* fix markdown style issues
---
python/README-CN.md | 21 +++++++++++++++++++++
python/README.md | 22 ++++++++++++++++++++++
python/requirements.txt | 3 +++
3 files changed, 46 insertions(+)
diff --git a/python/README-CN.md b/python/README-CN.md
new file mode 100644
index 00000000..a02e98c6
--- /dev/null
+++ b/python/README-CN.md
@@ -0,0 +1,21 @@
+# Python 客户端
+
+[English](README.md) | 简体中文 | [RocketMQ 官网](https://rocketmq.apache.org/)
+
+## 概述
+
+不同于[基于 RemotingCommand
协议的版本](https://github.com/apache/rocketmq/tree/develop/client)，当前的客户端基于
RocektMQ 5.0 存算分离架构进行设计开发，是 RocketMQ 社区目前推荐的接入方式，也是未来客户端演进的主要方向。
+
+在开始客户端的部分之前，所需的一些前期工作（或者参照[这里](https://rocketmq.apache.org/zh/docs/quickStart/02quickstart/)）：
+
+1. 准备 Python 环境。Python 3.7 是确保客户端运行的最小版本，Python 3.10 是推荐版本；
+2. 部署 namesrv，broker 以及
[proxy](https://github.com/apache/rocketmq/tree/develop/proxy) 组件。
+
+## 快速开始
+
+在`rocketmq-clients/python`目录下使用命令：`pip install -r requirements.txt` 即可安装相关依赖库。
+
+## 目前进展
+
+* 协议层代码生成完毕
+* rpcClient完成部分
diff --git a/python/README.md b/python/README.md
new file mode 100644
index 00000000..ee388872
--- /dev/null
+++ b/python/README.md
@@ -0,0 +1,22 @@
+# The Python Implementation of Apache RocketMQ Client
+
+English | [简体中文](README-CN.md) | [RocketMQ
Website](https://rocketmq.apache.org/)
+
+## Overview
+
+Here is the python implementation of the client for [Apache
RocketMQ](https://rocketmq.apache.org/). Different from the [remoting-based
client](https://github.com/apache/rocketmq/tree/develop/client), the current
implementation is based on separating architecture for computing and storage,
which is the more recommended way to access the RocketMQ service.
+
+Here are some preparations you may need to know (or refer to
[here](https://rocketmq.apache.org/docs/quickStart/02quickstart/https://rocketmq.apache.org/docs/quickStart/02quickstart/)).
+
+1. Python 3.7 is the minimum version required, Python 3.10 is the recommended
version.
+2. Setup namesrv, broker, and
[proxy](https://github.com/apache/rocketmq/tree/develop/proxy).
+
+## Getting Started
+
+To install the relevant dependency libraries, use the command "pip install -r
requirements.txt" in the directory "rocketmq-clients/python".
+
+## Current Progress
+
+* Protocol layer code generation is completed.
+
+* Partial completion of rpcClient.
diff --git a/python/requirements.txt b/python/requirements.txt
new file mode 100644
index 00000000..b63dce08
--- /dev/null
+++ b/python/requirements.txt
@@ -0,0 +1,3 @@
+grpc-interceptor==0.15.1
+grpcio==1.51.3
+grpcio-tools==1.51.3
\ No newline at end of file
