# pytautulli
[![codecov](https://codecov.io/gh/ludeeus/pytautulli/branch/main/graph/badge.svg)](https://codecov.io/gh/ludeeus/pytautulli)
![python version](https://img.shields.io/badge/Python-3.8=><=3.10-blue.svg)
[![PyPI](https://img.shields.io/pypi/v/pytautulli)](https://pypi.org/project/pytautulli)
![Actions](https://github.com/ludeeus/pytautulli/workflows/Actions/badge.svg?branch=main)
_Python API wrapper for Tautulli._
## Installation
```bash
python3 -m pip install pytautulli
```
## Example usage
More examples can be found in the `tests` directory.
```python
"""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
Raw data
{
"_id": null,
"home_page": "https://github.com/ludeeus/pytautulli",
"name": "pytautulli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": "",
"keywords": "pytautulli,tautulli,plex",
"author": "Joakim Sorensen",
"author_email": "hi@ludeeus.dev",
"download_url": "https://files.pythonhosted.org/packages/96/ec/66108771b1b1aa6b3c4406e5dfcfb9aa539d8873167fb03a9befe7b24c22/pytautulli-23.1.1.tar.gz",
"platform": null,
"description": "# pytautulli\n\n[![codecov](https://codecov.io/gh/ludeeus/pytautulli/branch/main/graph/badge.svg)](https://codecov.io/gh/ludeeus/pytautulli)\n![python version](https://img.shields.io/badge/Python-3.8=><=3.10-blue.svg)\n[![PyPI](https://img.shields.io/pypi/v/pytautulli)](https://pypi.org/project/pytautulli)\n![Actions](https://github.com/ludeeus/pytautulli/workflows/Actions/badge.svg?branch=main)\n\n_Python API wrapper for Tautulli._\n\n## Installation\n\n```bash\npython3 -m pip install pytautulli\n```\n\n## Example usage\n\nMore examples can be found in the `tests` directory.\n\n```python\n\"\"\"Example usage of pytautulli.\"\"\"\nimport asyncio\nfrom pytautulli import PyTautulli, PyTautulliHostConfiguration\n\nIP = \"192.168.100.3\"\nTOKEN = \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n\n\nasync def async_example():\n \"\"\"Example usage of pytautulli.\"\"\"\n host_configuration = PyTautulliHostConfiguration(ipaddress=IP, api_token=TOKEN)\n async with PyTautulli(host_configuration=host_configuration) as client:\n print(await client.async_command(\"get_activity\"))\n\n\nasyncio.get_event_loop().run_until_complete(async_example())\n```\n\n## Contribute\n\n**All** contributions are welcome!\n\n1. Fork the repository\n2. Clone the repository locally and open the devcontainer or use GitHub codespaces\n3. Do your changes\n4. Lint the files with `scripts/lint`\n5. Ensure all tests passes with `scripts/test`\n6. Ensure 100% coverage with `scripts/coverage`\n7. Commit your work, and push it to GitHub\n8. Create a PR against the `main` branch\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Python API wrapper for Tautulli.",
"version": "23.1.1",
"split_keywords": [
"pytautulli",
"tautulli",
"plex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "051eefb1a7dcedf77914d155591467340a85a938bcdb0f16fe97e64e83a8bbc9",
"md5": "9b905ae430295f3a1d606d3578c220de",
"sha256": "6ec86efc3f02872a8f5ab8f1a9ad4e3443d2398c38efbade717a1bc57a8b705e"
},
"downloads": -1,
"filename": "pytautulli-23.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9b905ae430295f3a1d606d3578c220de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 12616,
"upload_time": "2023-01-29T10:53:33",
"upload_time_iso_8601": "2023-01-29T10:53:33.554291Z",
"url": "https://files.pythonhosted.org/packages/05/1e/efb1a7dcedf77914d155591467340a85a938bcdb0f16fe97e64e83a8bbc9/pytautulli-23.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "96ec66108771b1b1aa6b3c4406e5dfcfb9aa539d8873167fb03a9befe7b24c22",
"md5": "c03aee82863494681fd0792c4035a6b5",
"sha256": "0819aa1d4856349060350be616a2783181038b56c9c6aa162ada350ef64a2d4a"
},
"downloads": -1,
"filename": "pytautulli-23.1.1.tar.gz",
"has_sig": false,
"md5_digest": "c03aee82863494681fd0792c4035a6b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 9708,
"upload_time": "2023-01-29T10:53:35",
"upload_time_iso_8601": "2023-01-29T10:53:35.078628Z",
"url": "https://files.pythonhosted.org/packages/96/ec/66108771b1b1aa6b3c4406e5dfcfb9aa539d8873167fb03a9befe7b24c22/pytautulli-23.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-29 10:53:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ludeeus",
"github_project": "pytautulli",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "pytautulli"
}