用于jive协作软件rest api v3的简单而有限的python客户端。
jiveapi的Python项目详细描述
范围和状态
我写这篇文章是为了成为一个围绕jive rest api的一小部分工作的python包装器——特别是,上传/发布更新文档、上传嵌入的图像,以及操作输入html以更好地在jive中显示。我是在个人时间做这件事的,但是我们将在工作中使用这个项目来满足一个非常有限的要求:"联合"文档,我们将在内部web服务器(主要是sphinx和hugo静态站点)上发布到我们公司的jive实例。这样做的主要目的是为了获得更广泛的受众和可搜索性,而不是忠实地再现原始html的布局和样式。我不打算在需要的基础上增加支持,但欢迎您提供帮助。
目前,这应该被视为阿尔法质量软件。它还很年轻,而且可能只有很少的代码路径是定期执行的,从我在实践和文档中看到的情况来看,我只能假设jive有许多错误情况,这个软件还没有看到。简而言之,就目前而言,要确保你能理智地检查事情,否则100%的时间都不依赖这个工作。我们非常欢迎错误报告,但请确保包含完整的调试输出。
至少对于这个初始版本,强烈建议您捕获调试级别的日志记录,因为这将包含出错时所需的jive内部id。
还要注意,jive 对html进行了大量修改,包括剥离和有时替换 id 属性、断开任何包含破折号的内部锚定链接等。此包中的高级方法尽最大努力修改html以使其在jive中工作,但没有是有保证的。再次强调,重点是内容而不是演示。
支持的操作
- 低级api(直接接口到jive api调用)
-
高级包装器api(提供生成参数和消息处理内容的帮助):
- 在给定HTML内容和一些参数的情况下创建和更新HTML文档,这些参数包括大多数常用参数,如要发布的位置、可见性、已发布/草稿状态和关键字。
- 尚未实现: 根据给定的HTML内容和一些参数(包括大多数常用参数,如发布位置、可见性、发布/草稿状态和关键字)创建和更新HTML文章。
- 修改html格式以使用jive ui约定("jive ize"html)。
- 给定一个html字符串,该字符串包含引用本地图像的图像标记和包含图像的文件系统路径,将每个图像上载到jive并修改html以指向图像的jive url。将有关内容和图像的元数据返回给用户以供将来更新。在以后的更新中使用此元数据可防止重新上载同一图像。
- 修改HTML以插入Jive样式信息/通知框作为页眉和页脚的选项,例如提醒用户不要直接在Jive上编辑文档的信息,并提供指向上次生成内容的规范源、提交和生成的链接。
- 将jive目录宏添加到内容开头的选项。
- jiveapi还包括一个基本的sphinx主题(称为jiveapi)和builder(也称为jiveapi)优化,用于构建上传到jive的单页html。