outline-wiki-api 0.3.1

A python API for Outline Wiki.

Outline Wiki Python API

A python wrapper for Outline knowledge base platform API.

For full Outline API documentation visit Outline Developers page.

[!NOTE] Relevant for Outline version 0.85.1

[!IMPORTANT] The main branch may be in an unstable or even broken state during development. For stable versions, see releases.

---

Installation

python3 -m pip install outline-wiki-api

---

Usage

Let's try to search a document in our knowledge base and look through the results:

from outline_wiki_api import OutlineWiki

OUTLINE_URL = "https://my.outline.com"
OUTLINE_TOKEN = "mysecrettoken"

app = OutlineWiki(url=OUTLINE_URL, token=OUTLINE_TOKEN)

search_results = app.documents.search(query='outline').data

for result in search_results:
    print(f"document_title: {result.document.title} | "
          f"ranking: {result.ranking} | "
          f"context: {result.context[0:20].replace('\n', ' ')}\n")

You can find more usage examples in the docs.

Community Tools & Examples

The following third-party scripts/extensions use outline-wiki-api and may be useful for specific workflows:

• Outline -> RAGFlow Sync Tool - a tool sync documents between Outline and RAGFlow (made by @metorm)

[!NOTE] These tools are maintained by the community and not part of the core outline-wiki-api project.

---

License

This library is a wrapper, not affiliated with Outline.

Outline itself is BSL 1.1 licensed.

Use of Outline’s API via this wrapper must comply with Outline's licensing terms.

The original code of the wrapper is under the Apache 2.0 license. See the LICENSE file for details.