Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.38 KB

README.md

File metadata and controls

46 lines (28 loc) · 2.38 KB

A Python client for Tautulli's API

PyPi License

Open Issues Closed Issues Latest Release

Discord Twitter

Interact with Tautulli's API in Python

Installation

  • From PyPi (recommended): python -m pip install tautulli
  • From GitHub python -m pip install git+https://github.com/nwithan8/pytulli.git
    • This is not recommended, as the version will always default to 0.0.0

Usage

This client covers nearly 100% of all Tautulli's available API calls, including type checks and enforcing required variables.

More details about Tautulli's API can be found on the Tautulli's GitHub wiki page.

Most API call functions that return data return raw JSON data. Some return strings or file contents (in the case of downloads).

API calls functions that do not return data return True/False booleans to confirm that the API call was successful.

Import the tautulli package as initialize the API Example:

from tautulli import RawAPI

api = RawAPI(base_url="http://myipaddress:port", api_key="thisisanapikey")

You can optionally pass verbose=True into the API declaration to produce verbose debugging logs and error messages.

Additional utilities and shortcuts can be accessed via the tautulli.tools module.

Documentation

Documentation available on ReadTheDocs