Python SDK

Install and start using the Python SDK.

Intro

The SentimentScan API SDK provides access to the SentimentScan API REST APIs.

Lexicon-based sentiment analysis for short texts. Returns a polarity score from -1 (negative) to +1 (positive), a label, and per-word drivers.

Installation

Add the SDK to your project from its folder, with whichever package manager your project uses. Give each tool a path containing a slash, such as ../sentiment-scan-api — a bare folder name is looked up on PyPI instead, and resolves to whatever project holds that name there:

Terminal
pip install <path-to-sdk>
Terminal
uv add <path-to-sdk>
Terminal
poetry add <path-to-sdk>

Quick Start

Synchronous client

Construct SentimentScanApiClient with keyword arguments, and call close() when you are done. Every argument is optional.

Python
from sentiment_scan_api import SentimentScanApiClient

client = SentimentScanApiClient()

client.close()

Alternatively, scope it — with SentimentScanApiClient(...) as client: closes the pool on exit.

Asynchronous client

AsyncSentimentScanApiClient mirrors SentimentScanApiClient with identical method names, and every endpoint method is a coroutine. It takes the same arguments, with some differences — for example, the transport argument is custom_async_http_client.

Python
from asyncio import run

from sentiment_scan_api import AsyncSentimentScanApiClient


async def main() -> None:
    client = AsyncSentimentScanApiClient()
    await client.aclose()


run(main())

Alternatively, scope it — async with AsyncSentimentScanApiClient(...) as client: closes the pool on exit.

On this page