fluidtopics 1.0.3

Fluid Topics API

Python Fluid Topics API

The Python Fluid Topics API is an integrator kit for developing Fluid Topics connectors.

Installation

We recommend using https://pypi.org/project/fluidtopics/ to install the Fluid Topics API for Python.

$ pip install fluidtopics

Getting started

We will see how to publish to Fluid Topics. To do this, you should have a Fluid Topics user with KHUB_ADMIN right.

1. Create external source

To use this api, a Fluid Topics external source should be created. It is possible to do it manually, or programmatically:

from fluidtopics.connector import LoginAuthentication, RemoteClient

# First, create a RemoteClient
auth = LoginAuthentication('[e-mail]', 'user_password')
client = RemoteClient('https://my-fluidtopics.com', auth, 'external_source_id')

# Then create the source
client.create_source()

2. Publish document

When the RemoteClient and the external source are created, it is possible to publish in Fluid Topics.

Structured document

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)

Unstructured document

from fluidtopics.connector import UnstructuredDocument

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

client.publish(document)

uri parameter can be a file path, or an url.

External document

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)