调用H API的工具和组件
h-api的Python项目详细描述
美国石油学会
调用H API的工具和组件
这个包裹对你不太可能有用
除非你为假设工作,否则这个包裹不会很好 对你有用。你可以随便闲逛一下,但不要惊讶 没什么意义。在
目前不仅不应该使用这个包,我们的 身份验证也会阻止它。在
使用
要为批量API调用构造NDJSON:
fromh_api.enumsimportViewTypefromh_api.bulk_apiimportCommandBuilder,BulkAPI,Executornd_json=BulkAPI.to_string([# It's your job to put the right commands here. # This also accepts a generatorCommandBuilder.configure(effective_user="acct:example@lms.hypothes.is",total_instructions=4,view=ViewType.BASIC),CommandBuilder.user.upsert({"username":"username","authority":"authority","display_name":"display_name","identities":[{"provider":"provider","provider_unique_id":"provider_unique_id"}],},"user_ref"),CommandBuilder.group.upsert({"name":"name","authority":"authority","authority_provided_id":"authority_provided_id"},"group_ref"),# These references here match those we assigned to the objects aboveCommandBuilder.group_membership.create("user_ref","group_ref")])# It's now your job to send this off to H
要接受和处理如上所述的NDJSON请求:
^{pr2}$黑客攻击
在开发环境中安装h-api
您需要
克隆git repo
git clone https://github.com/hypothesis/h-api.git
这将把代码下载到h-api
目录中
在当前工作目录中。你需要在
h-api
目录,用于安装的其余部分
流程:
cd h-api
运行测试
make test
就这样!您已经完成了h-api的设置
发展环境。运行make help
查看
可用于线切割、代码格式化、包装等
更新Cookiecutter脚手架
此项目是从 https://github.com/hypothesis/h-cookiecutter-pypackage/模板。 如果h-cookiecutter-pypackage本身在这个项目创建后发生了变化,并且 如果要用最新的更改更新此项目,可以“重播” 这个项目的厨师长。运行:
make template
这将更改工作树中的文件,应用最新的 h-cookiecutter-pypackage模板的更新。检查和测试 更改,执行任何需要的修正,然后将它们提交到git并发送 拉取请求。在
如果您希望make template
跳过某些文件,永远不要更改它们,请添加
将这些文件"options.disable_replay"
放入
^{
如果您希望make template
更新disable_replay
中列出的文件
只需删除该文件,然后运行make template
,它将重新创建该文件
为你。在
- 项目
标签: