Python 流体主题 API

Python Fluid Topics API 是一个用于开发 Fluid Topics 连接器的集成工具包。

安装

我们建议使用https://pypi.org/project/fluidtopics/安装适用于 Python 的 Fluid Topics API。

$ pip install fluidtopics

入门

我们将看到如何发布到流体主题。为此，您应该有一个具有 KHUB_ADMIN 权限的 Fluid Topics 用户。

1.创建外部源

要使用这个 api，应该创建一个 Fluid Topics 外部源。可以手动或以编程方式进行：

from fluidtopics.connector import LoginAuthentication, RemoteClient

# First, create a RemoteClient
auth = LoginAuthentication('khub_admin_user@domain.com', 'user_password')
client = RemoteClient('https://my-fluidtopics.com', auth, 'external_source_id')

# Then create the source
client.create_source()

2. 发布文档

创建RemoteClient外部源时，可以在流体主题中发布。

结构化文件

from fluidtopics.connector import StructuredDocument, Topic

topic = Topic.create(
    topic_id='first_step',
    title='First step',
    body='<p>First, read this tutorial</p>'
)
document = StructuredDocument.create(
    document_id='readme',
    title='How to use fluidtopics python API',
    toc=[topic]
)

client.publish(document)

非结构化文档

from fluidtopics.connector import UnstructuredDocument

document = UnstructuredDocument.from_uri(
    document_id='markdown_readme',
    uri='./README.md'
)

client.publish(document)

uri参数可以是文件路径，也可以是 url。

外部文件

from fluidtopics.connector import ExternalDocument

document = ExternalDocument.create(
    document_id='fluidtopics_on_pypi',
    title='Fluid Topics python API on pypi.org',
    url='https://pypi.org/project/fluidtopics/'
)

client.publish(document)