docparser api的python客户端
PyDocParser的Python项目详细描述
docparser api的非官方python客户端
目录
安装
安装,用于一般用途:
注意:pydocparser只测试了python3(不保证对python2有效)
pip install pydocparser
或者如果你有Python3pip3 install pydocparser
或
您可以从here下载您选择的版本
解压缩文件
将目录更改为未压缩的文件夹
运行python setup.py install
或python3 setup.py install
开发安装:
git clone https://github.com/tman540/pydocparser
pip install -r requirements.txt
用法
要使用pydocparser,必须从pydocparser
模块创建Parser
类的实例:
importpydocparserparser=pydocparser.Parser()
接下来,您必须获得您的秘密api密钥(您可以从here获得该密钥)
现在,pydocparser需要这个密钥才能访问您的帐户。你可以这样做:
parser.login(YOUR_API_KEY_HERE)
docparser api有一个函数,用于测试与api的连接
result=parser.ping()print(result)# pong
如果parser.ping()
返回'pong',则您已成功连接到docparser api。如果您得到这样的输出:Invalid API key. Use Parser.login(api_key)
并且您输入了您的api密钥,请确保您的api密钥是正确的。
您可以获得如下当前解析器的列表:
parsers=parser.get_parsers()
这将返回所有可用解析器的名称列表。
要将文件上载到docparser,可以使用upload
函数:
id=parser.upload("fileone.pdf","PDF Parser")#ars: file to upload, the name of the parser
函数将返回刚刚上载的文件的文档ID。要检索解析的数据,可以调用fetch
函数:
data=parser.fetch("PDF Parser",id)# The id is the doc id that was returned by `parser.upload()`
fetch
返回所选文件的所有分析数据
贡献
这个项目从工作时需要通过python使用docparser开始。我注意到python没有api库,所以我决定自己制作。我是一个人的行动,所以我很高兴接受任何我能得到的帮助。您可以通过进行更改、提交包含所添加内容的详细说明的请求来做出贡献。我将审查您的更改,如果我决定您的更改将进入下一个版本,我将相应地记入您的贷方。您还可以通过github问题提交bug报告/功能请求。
许可证
此库在MIT License上可用作开放源代码。
更改日志
v1.0(7/11/19)初始版本
V1.1 (7/12/19) Bug Fixes + New Functions
待办事项
- []将函数名更改为更接近php/node/ajax客户机中的函数名
- [X]更新setup.py以包含安装要求
- [X]修复readme.md以更好地处理PyPi