与workpath API交互的包
workpathapi的Python项目详细描述
工作路径API
先决条件
只有一个必需的Python包需要安装才能使用workpath
,即requests
。可以使用以下命令安装它。在
pip install requests
如果希望API返回pandas数据帧,则需要安装pandas。在
^{pr2}$安装
如果满足所有先决条件,则安装过程就像执行命令一样简单
pip install workpath
使用
要从工作路径API获取数据,只需要三个步骤。在
1。导入模块
导入模块,例如这样。在
from workpathapi import WorkpathAPI
2。工作路径API创建WorkpathAPI的实例。在
api = WorkpathAPI(company='dataatelier', api_token='YOUR_WORKPATH_TOKEN')
你需要传递两个参数。你的公司和API令牌。
注意:如果您的API标记被设置为环境变量WORKPATH_API_TOKEN = "YOUR_WORKPATH_TOKEN"
,那么您不必传递参数api_token
。在
3。从API获取目标
如果你想实现所有的目标,只要执行
goals = api.get_goals()
输出对应于API端点goals
的输出,描述为here
如果希望结果是pandas数据帧,可以传递参数output_format='DataFrame'
如果你想要一个特定目标的信息,你可以执行
goal = api.get_goal(goal_id=1001)
有关详细信息,请参见APIdocumentation。在
标签:
- 项目
推荐PyPI第三方库
创建WorkpathAPI的实例。在
api = WorkpathAPI(company='dataatelier', api_token='YOUR_WORKPATH_TOKEN')
你需要传递两个参数。你的公司和API令牌。
注意:如果您的API标记被设置为环境变量WORKPATH_API_TOKEN = "YOUR_WORKPATH_TOKEN"
,那么您不必传递参数api_token
。在
3。从API获取目标
如果你想实现所有的目标,只要执行
goals = api.get_goals()
输出对应于API端点goals
的输出,描述为here
如果希望结果是pandas数据帧,可以传递参数output_format='DataFrame'
如果你想要一个特定目标的信息,你可以执行
goal = api.get_goal(goal_id=1001)
有关详细信息,请参见APIdocumentation。在
- 项目
标签: