Skip to content

A python module to get information from Tautulli

License

Notifications You must be signed in to change notification settings

ludeeus/pytautulli

Repository files navigation

pytautulli

codecov python version PyPI Actions

Python API wrapper for Tautulli.

Installation

python3 -m pip install pytautulli

Example usage

More examples can be found in the tests directory.

"""Example usage of pytautulli."""
import asyncio
from pytautulli import PyTautulli, PyTautulliHostConfiguration

IP = "192.168.100.3"
TOKEN = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"


async def async_example():
    """Example usage of pytautulli."""
    host_configuration = PyTautulliHostConfiguration(ipaddress=IP, api_token=TOKEN)
    async with PyTautulli(host_configuration=host_configuration) as client:
        print(await client.async_command("get_activity"))


asyncio.get_event_loop().run_until_complete(async_example())

Contribute

All contributions are welcome!

  1. Fork the repository
  2. Clone the repository locally and open the devcontainer or use GitHub codespaces
  3. Do your changes
  4. Lint the files with scripts/lint
  5. Ensure all tests passes with scripts/test
  6. Ensure 100% coverage with scripts/coverage
  7. Commit your work, and push it to GitHub
  8. Create a PR against the main branch