tautulli


Nametautulli JSON
Version 3.0.2.2103 PyPI version JSON
download
home_pagehttps://github.com/nwithan8/pytulli
SummaryA complete Python client for Tautulli's API
upload_time2022-09-29 21:45:44
maintainer
docs_urlNone
authorNate Harris
requires_python>=3.7, <4
licenseGNU General Public License v3 (GPLv3)
keywords tautulli api client plex pms plex media server media server json
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # A Python client for Tautulli's API
[![PyPi](https://img.shields.io/pypi/dm/tautulli?label=Downloads&logo=pypi)](https://pypi.org/project/tautulli)
[![License](https://img.shields.io/pypi/l/tautulli?color=orange&style=flat-square)](https://github.com/nwithan8/pytulli/blob/master/LICENSE)

[![Open Issues](https://img.shields.io/github/issues-raw/nwithan8/pytulli?color=gold&style=flat-square)](https://github.com/nwithan8/pytulli/issues?q=is%3Aopen+is%3Aissue)
[![Closed Issues](https://img.shields.io/github/issues-closed-raw/nwithan8/pytulli?color=black&style=flat-square)](https://github.com/nwithan8/pytulli/issues?q=is%3Aissue+is%3Aclosed)
[![Latest Release](https://img.shields.io/github/v/release/nwithan8/pytulli?color=red&label=latest%20release&logo=github&style=flat-square)](https://github.com/nwithan8/pytulli/releases)

[![Discord](https://img.shields.io/discord/472537215457689601?color=blue&logo=discord&style=flat-square)](https://discord.gg/7jGbCJQ)
[![Twitter](https://img.shields.io/twitter/follow/nwithan8?label=%40nwithan8&logo=twitter&style=flat-square)](https://twitter.com/nwithan8)

Interact with Tautulli's API in Python

# Installation
From PyPi: ``python -m pip install tautulli``

From GitHub ``python -m pip install git+https://github.com/nwithan8/pytulli.git``

# 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](https://github.com/Tautulli/Tautulli-Wiki/wiki/Tautulli-API-Reference).

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:
```python
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](https://pytulli.readthedocs.io/en/latest/documentation.html)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/nwithan8/pytulli",
    "name": "tautulli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7, <4",
    "maintainer_email": "",
    "keywords": "Tautulli,API,client,Plex,PMS,Plex Media Server,media,server,JSON",
    "author": "Nate Harris",
    "author_email": "n8gr8gbln@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/29/4c/2012b5f6f9c96c0041b099a6ce50b5bc311a0619a99b74f759ee9d0b8a44/tautulli-3.0.2.2103.tar.gz",
    "platform": null,
    "description": "# A Python client for Tautulli's API\n[![PyPi](https://img.shields.io/pypi/dm/tautulli?label=Downloads&logo=pypi)](https://pypi.org/project/tautulli)\n[![License](https://img.shields.io/pypi/l/tautulli?color=orange&style=flat-square)](https://github.com/nwithan8/pytulli/blob/master/LICENSE)\n\n[![Open Issues](https://img.shields.io/github/issues-raw/nwithan8/pytulli?color=gold&style=flat-square)](https://github.com/nwithan8/pytulli/issues?q=is%3Aopen+is%3Aissue)\n[![Closed Issues](https://img.shields.io/github/issues-closed-raw/nwithan8/pytulli?color=black&style=flat-square)](https://github.com/nwithan8/pytulli/issues?q=is%3Aissue+is%3Aclosed)\n[![Latest Release](https://img.shields.io/github/v/release/nwithan8/pytulli?color=red&label=latest%20release&logo=github&style=flat-square)](https://github.com/nwithan8/pytulli/releases)\n\n[![Discord](https://img.shields.io/discord/472537215457689601?color=blue&logo=discord&style=flat-square)](https://discord.gg/7jGbCJQ)\n[![Twitter](https://img.shields.io/twitter/follow/nwithan8?label=%40nwithan8&logo=twitter&style=flat-square)](https://twitter.com/nwithan8)\n\nInteract with Tautulli's API in Python\n\n# Installation\nFrom PyPi: ``python -m pip install tautulli``\n\nFrom GitHub ``python -m pip install git+https://github.com/nwithan8/pytulli.git``\n\n# Usage\nThis client covers nearly 100% of all Tautulli's available API calls, including type checks and enforcing required variables.\n\nMore details about Tautulli's API can be found on the [Tautulli's GitHub wiki page](https://github.com/Tautulli/Tautulli-Wiki/wiki/Tautulli-API-Reference).\n\nMost API call functions that return data return raw JSON data. Some return strings or file contents (in the case of downloads).\n\nAPI calls functions that do not return data return `True`/`False` booleans to confirm that the API call was successful.\n\nImport the ``tautulli`` package as initialize the API\nExample:\n```python\nfrom tautulli import RawAPI\n\napi = RawAPI(base_url=\"http://myipaddress:port\", api_key=\"thisisanapikey\")\n```\n\nYou can optionally pass ``verbose=True`` into the API declaration to produce verbose debugging logs and error messages.\n\nAdditional utilities and shortcuts can be accessed via the `tautulli.tools` module.\n\n# Documentation\n\nDocumentation available on [ReadTheDocs](https://pytulli.readthedocs.io/en/latest/documentation.html)\n\n\n",
    "bugtrack_url": null,
    "license": "GNU General Public License v3 (GPLv3)",
    "summary": "A complete Python client for Tautulli's API",
    "version": "3.0.2.2103",
    "split_keywords": [
        "tautulli",
        "api",
        "client",
        "plex",
        "pms",
        "plex media server",
        "media",
        "server",
        "json"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "36a4bfa854eda731e6025b889be53287",
                "sha256": "d04b0a744453ecf83a2685de3afa02912f0e344818211f8abc0c45a5e657168a"
            },
            "downloads": -1,
            "filename": "tautulli-3.0.2.2103-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "36a4bfa854eda731e6025b889be53287",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7, <4",
            "size": 88442,
            "upload_time": "2022-09-29T21:45:42",
            "upload_time_iso_8601": "2022-09-29T21:45:42.157285Z",
            "url": "https://files.pythonhosted.org/packages/a5/96/f89299f52f94b134879c3fffba03cc54508ddb4d82ddb1fe6b77b99ed60f/tautulli-3.0.2.2103-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "79d36d5ad4e6809a9272c9bdfb819d5a",
                "sha256": "83a777d36b53abd65692ecb523d3e8f89e8d1a7025937586fadad5120091e2ab"
            },
            "downloads": -1,
            "filename": "tautulli-3.0.2.2103.tar.gz",
            "has_sig": false,
            "md5_digest": "79d36d5ad4e6809a9272c9bdfb819d5a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7, <4",
            "size": 62415,
            "upload_time": "2022-09-29T21:45:44",
            "upload_time_iso_8601": "2022-09-29T21:45:44.313378Z",
            "url": "https://files.pythonhosted.org/packages/29/4c/2012b5f6f9c96c0041b099a6ce50b5bc311a0619a99b74f759ee9d0b8a44/tautulli-3.0.2.2103.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-09-29 21:45:44",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "nwithan8",
    "github_project": "pytulli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "tautulli"
}
        
Elapsed time: 0.47868s