From 70d04e82653120873f20efcce11b08034e446060 Mon Sep 17 00:00:00 2001 From: jackjls <24503619+jackjls@users.noreply.github.com> Date: Mon, 28 Sep 2026 10:30:59 +0800 Subject: [PATCH] docs: recommend PyPI installation in README --- README.md | 14 +++++++++++++- README_EN.md | 10 ++++++++-- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5bd5fc5..cd174bc 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,19 @@ ### 2. 安装 SDK -当前从 GitHub 源码安装: +推荐通过 [PyPI](https://pypi.org/project/ftshare/) 安装(需要 Python 3.9 及以上): + +```bash +pip install ftshare +``` + +升级到最新版本: + +```bash +pip install --upgrade ftshare +``` + +`pandas` 和 `requests` 等运行依赖会自动安装。如需本地开发,也可以从 GitHub 源码安装: ```bash git clone https://github.com/FTShare-Lab/FTShare-python-sdk.git diff --git a/README_EN.md b/README_EN.md index ce5b0df..8d60b4c 100644 --- a/README_EN.md +++ b/README_EN.md @@ -29,12 +29,18 @@ FTShare-python-sdk # Python data access layer ## Installation -Install from PyPI: +Install from [PyPI](https://pypi.org/project/ftshare/) (Python 3.9 or later required): ```bash pip install ftshare ``` +Upgrade to the latest version: + +```bash +pip install --upgrade ftshare +``` + For local development, clone this repository and install it in editable mode with test dependencies: ```bash @@ -69,7 +75,7 @@ The output is a pandas `DataFrame`. For example, the financial calendar endpoint Install the SDK first: ```bash -pip install -e . +pip install ftshare ``` Then use it from any Python project: