Sypht Python 客户端使用教程
1. 项目的目录结构及介绍
sypht-python-client/
├── README.md
├── setup.py
├── sypht/
│ ├── __init__.py
│ ├── client.py
│ └── ...
└── ...
- README.md: 项目说明文档。
- setup.py: 项目安装脚本。
- sypht/: 主要代码目录。
- init.py: 模块初始化文件。
- client.py: 客户端主要功能实现文件。
2. 项目的启动文件介绍
项目的启动文件主要是 client.py
,其中包含了 Sypht 客户端的主要功能实现。以下是 client.py
的主要内容:
from sypht.client import SyphtClient
sc = SyphtClient('<client_id>', '<client_secret>')
with open('invoice.png', 'rb') as f:
fid = sc.upload(f, products=["forms-&-reports"])
print(sc.fetch_results(fid))
- SyphtClient: 客户端类,用于与 Sypht API 进行交互。
- upload: 上传文件方法。
- fetch_results: 获取分析结果方法。
3. 项目的配置文件介绍
项目没有显式的配置文件,但可以通过环境变量或直接在代码中设置 client_id
和 client_secret
。
from sypht.client import SyphtClient
sc = SyphtClient('<client_id>', '<client_secret>')
或者通过环境变量设置:
export SYPHT_API_KEY="<client_id>:<client_secret>"
在代码中使用:
from sypht.client import SyphtClient
sc = SyphtClient(api_key=os.getenv('SYPHT_API_KEY'))
以上是 Sypht Python 客户端的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。