Skip to content

docs: 推荐通过 PyPI 安装 FTShare SDK #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jackjls merged 1 commit into from
Sep 28, 2026
Merged

docs: 推荐通过 PyPI 安装 FTShare SDK #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 8 additions & 2 deletions README_EN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
Loading