Skip to content

Commit e694274

Browse files
rogerhuangrogerhuang
authored andcommitted
fix: remove old files
1 parent ff277a7 commit e694274

File tree

15 files changed

+33
-1456
lines changed

15 files changed

+33
-1456
lines changed

PUBLISH.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,31 @@
11
# 如何将linkis-python-sdk发布到PyPI
2+
23
# How to Publish linkis-python-sdk to PyPI
34

45
本文档描述了如何构建并将linkis-python-sdk包发布到PyPI,以便用户可以通过pip安装。
6+
57
This document describes how to build and publish the linkis-python-sdk package to PyPI so that users can install it via pip.
68

79
## 准备工作
10+
811
## Preparation
912

1013
1. 确保你已经安装了必要的工具:
14+
1115
1. Make sure you have the necessary tools installed:
1216

1317
```bash
1418
pip install build twine
1519
```
1620

1721
2. 更新版本号:
22+
1823
2. Update the version number:
1924
-`linkis_python_sdk/__init__.py`中更新`__version__`变量
2025
- Update the `__version__` variable in `linkis_python_sdk/__init__.py`
2126

2227
3. 确认所有文件已添加到git:
28+
2329
3. Confirm all files have been added to git:
2430
- `setup.py`
2531
- `pyproject.toml`
@@ -30,19 +36,23 @@ pip install build twine
3036
- `setup.cfg`
3137

3238
## 构建包
39+
3340
## Build the Package
3441

3542
执行以下命令构建分发包:
43+
3644
Execute the following command to build distribution packages:
3745

3846
```bash
3947
python -m build
4048
```
4149

4250
这将在`dist/`目录下创建源码包(`.tar.gz`)和轮子包(`.whl`)。
51+
4352
This will create source packages (`.tar.gz`) and wheel packages (`.whl`) in the `dist/` directory.
4453

4554
## 测试包
55+
4656
## Test the Package
4757

4858
在发布到PyPI之前,建议先测试安装:
@@ -53,43 +63,51 @@ pip install dist/linkis_python_sdk-x.y.z-py3-none-any.whl
5363
```
5464

5565
## 上传到TestPyPI(可选)
66+
5667
## Upload to TestPyPI (Optional)
5768

5869
先上传到TestPyPI测试是一个好习惯:
70+
5971
It's good practice to first upload to TestPyPI for testing:
6072

6173
```bash
6274
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
6375
```
6476

6577
然后测试从TestPyPI安装:
78+
6679
Then test installing from TestPyPI:
6780

6881
```bash
6982
pip install --index-url https://test.pypi.org/simple/ linkis-python-sdk
7083
```
7184

7285
## 上传到PyPI
86+
7387
## Upload to PyPI
7488

7589
一切就绪后,上传到真正的PyPI:
90+
7691
When everything is ready, upload to the actual PyPI:
7792

7893
```bash
7994
twine upload dist/*
8095
```
8196

8297
## 验证安装
98+
8399
## Verify Installation
84100

85101
确认包已成功发布:
102+
86103
Confirm the package has been successfully published:
87104

88105
```bash
89106
pip install linkis-python-sdk
90107
```
91108

92109
## 相关链接
110+
93111
## Related Links
94112

95113
- PyPI: https://pypi.org/

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,23 @@
11
# Linkis Python SDK
22

3-
Linkis Python SDK是与[Apache Linkis](https://linkis.apache.org/)服务交互的官方Python客户端库。该SDK提供了简便的接口,用于执行代码并获取结果,支持同步和异步操作。
4-
Linkis Python SDK is the official Python client library for interacting with [Apache Linkis](https://linkis.apache.org/) services. This SDK provides convenient interfaces for executing code and retrieving results, supporting both synchronous and asynchronous operations.
3+
Linkis Python SDK是与[Apache Linkis](https://linkis.apache.org/)服务交互的Python客户端库。该SDK提供了简便的接口,用于执行代码并获取结果,支持同步和异步操作。
4+
5+
Linkis Python SDK is the Python client library for interacting with [Apache Linkis](https://linkis.apache.org/) services. This SDK provides convenient interfaces for executing code and retrieving results, supporting both synchronous and asynchronous operations.
56

67
[![PyPI version](https://badge.fury.io/py/linkis-python-sdk.svg)](https://badge.fury.io/py/linkis-python-sdk)
8+
79
[![Python Version](https://img.shields.io/pypi/pyversions/linkis-python-sdk.svg)](https://pypi.org/project/linkis-python-sdk/)
810

911
## 安装
12+
1013
## Installation
1114

1215
```bash
1316
pip install linkis-python-sdk
1417
```
1518

1619
## 功能特点
20+
1721
## Features
1822

1923
- 支持同步和异步客户端
@@ -27,9 +31,11 @@ pip install linkis-python-sdk
2731
- Easy conversion of results to Pandas DataFrame
2832

2933
## 使用示例
34+
3035
## Usage Examples
3136

3237
### 同步客户端
38+
3339
### Synchronous Client
3440

3541
```python
@@ -70,6 +76,7 @@ print(f"Data: {data}")
7076
```
7177

7278
### 异步客户端
79+
7380
### Asynchronous Client
7481

7582
```python
@@ -115,9 +122,11 @@ if __name__ == "__main__":
115122
```
116123

117124
## 带缓存的执行
125+
118126
## Execution with Caching
119127

120128
SDK还支持使用Redis缓存执行结果,以提高性能:
129+
121130
The SDK also supports caching execution results with Redis to improve performance:
122131

123132
```python
@@ -157,6 +166,7 @@ data, total, error = client.execute_code_with_cache(
157166
```
158167

159168
## 依赖项
169+
160170
## Dependencies
161171

162172
- Python >= 3.9
@@ -166,13 +176,16 @@ data, total, error = client.execute_code_with_cache(
166176
- aiohttp
167177

168178
## 开发贡献
179+
169180
## Development and Contribution
170181

171182
欢迎为Linkis Python SDK做出贡献!请参阅[PUBLISH.md](PUBLISH.md)了解如何构建和发布该包。
172183
Contributions to the Linkis Python SDK are welcome! Please refer to [PUBLISH.md](PUBLISH.md) for information on how to build and publish the package.
173184

174185
## 许可证
186+
175187
## License
176188

177189
该项目采用[Apache License 2.0](LICENSE)许可证。
190+
178191
This project is licensed under the [Apache License 2.0](LICENSE).

README_CN.md

Lines changed: 0 additions & 118 deletions
This file was deleted.

0 commit comments

Comments
 (0)