# dizqueTV-python
[![PyPi](https://img.shields.io/pypi/dm/dizquetv?color=green&label=PyPi%20downloads&logo=Pypi&logoColor=orange&style=flat-square)](https://pypi.org/project/dizqueTV/)
[![Python support](https://img.shields.io/pypi/pyversions/dizquetv?color=purple&label=Python%20support&logo=python&logoColor=yellow&style=flat-square)]()
[![License](https://img.shields.io/pypi/l/dizquetv?color=orange&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/blob/master/LICENSE)
[![Open Issues](https://img.shields.io/github/issues-raw/nwithan8/dizqueTV-python?color=gold&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/issues?q=is%3Aopen+is%3Aissue)
[![Closed Issues](https://img.shields.io/github/issues-closed-raw/nwithan8/dizqueTV-python?color=black&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/issues?q=is%3Aissue+is%3Aclosed)
[![Activity](https://img.shields.io/github/commit-activity/m/nwithan8/dizqueTV-python?color=red&style=flat-square)]()
[![Latest Release](https://img.shields.io/github/v/release/nwithan8/dizqueTV-python?color=red&label=latest%20release&logo=github&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/releases)
[![Docs](https://img.shields.io/readthedocs/dizquetv?style=flat-square)](http://dizquetv.readthedocs.io/)
[![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)
A Python library to interact with a [dizqueTV](https://github.com/vexorian/dizquetv) instance
## Installation
#### From GitHub
1. Clone repository with ``git clone https://github.com/nwithan8/dizqueTV-python.git``
2. Enter project folder with ``cd dizqueTV-python``
3. Install requirements with ``pip install -r requirements.txt``
#### From PyPi
Run ``pip install dizqueTV``
## Setup
Import the ``API`` class from the ``dizqueTV`` module
Ex.
```
from dizqueTV import API
dtv = API(url="http://localhost:8000")
```
Enable verbose logging by passing ``verbose=True`` into the ``API`` object declaration
## Usage
Documentation available on [ReadTheDocs](https://dizquetv.readthedocs.io/en/latest/)
### Exceptions
- ``MissingSettingsError``: The kwargs you have provided to create a new object (ex. ``Channel`` or ``PlexServer``) are incomplete
- ``MissingParametersError``: You did not provide a required parameter in your function call (ex. provide a PlexAPI Server when adding PlexAPI Video to a channel)
- ``NotRemoteObjectError``: The object you are calling this method on is a locally-created object that does not exist on the dizqueTV server
- ``ChannelCreationError``: An error occurred when creating a Channel object
## Contact
Please leave a pull request if you would like to contribute.
Join the dizqueTV Discord server (link on [project page](https://github.com/vexorian/dizquetv)). My Discord username is **nwithan8#8438**
Follow me on Twitter: [@nwithan8](https://twitter.com/nwithan8)
Also feel free to check out my other projects here on [GitHub](https://github.com/nwithan8) or join the #developer channel in my Discord server below.
<div align="center">
<p>
<a href="https://discord.gg/ygRDVE9"><img src="https://discordapp.com/api/guilds/472537215457689601/widget.png?style=banner2" alt="" /></a>
</p>
</div>
Raw data
{
"_id": null,
"home_page": "https://github.com/nwithan8/dizqueTV-python",
"name": "dizqueTV",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "dizqueTV,Plex,Jellyfin,Emby,media,API,server,interaction,TV,television,streaming",
"author": "Nate Harris",
"author_email": "n8gr8gbln@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/dd/77c818323a39e99b6585c30da7f8fa44d703573046b545e9b32d9f0db72e/dizqueTV-1.5.3.0.tar.gz",
"platform": null,
"description": "# dizqueTV-python\n[![PyPi](https://img.shields.io/pypi/dm/dizquetv?color=green&label=PyPi%20downloads&logo=Pypi&logoColor=orange&style=flat-square)](https://pypi.org/project/dizqueTV/)\n[![Python support](https://img.shields.io/pypi/pyversions/dizquetv?color=purple&label=Python%20support&logo=python&logoColor=yellow&style=flat-square)]()\n[![License](https://img.shields.io/pypi/l/dizquetv?color=orange&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/blob/master/LICENSE)\n\n[![Open Issues](https://img.shields.io/github/issues-raw/nwithan8/dizqueTV-python?color=gold&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/issues?q=is%3Aopen+is%3Aissue)\n[![Closed Issues](https://img.shields.io/github/issues-closed-raw/nwithan8/dizqueTV-python?color=black&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/issues?q=is%3Aissue+is%3Aclosed)\n[![Activity](https://img.shields.io/github/commit-activity/m/nwithan8/dizqueTV-python?color=red&style=flat-square)]()\n\n[![Latest Release](https://img.shields.io/github/v/release/nwithan8/dizqueTV-python?color=red&label=latest%20release&logo=github&style=flat-square)](https://github.com/nwithan8/dizqueTV-python/releases)\n[![Docs](https://img.shields.io/readthedocs/dizquetv?style=flat-square)](http://dizquetv.readthedocs.io/)\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\nA Python library to interact with a [dizqueTV](https://github.com/vexorian/dizquetv) instance\n\n## Installation\n#### From GitHub\n1. Clone repository with ``git clone https://github.com/nwithan8/dizqueTV-python.git``\n2. Enter project folder with ``cd dizqueTV-python``\n3. Install requirements with ``pip install -r requirements.txt``\n\n#### From PyPi\nRun ``pip install dizqueTV``\n\n## Setup\nImport the ``API`` class from the ``dizqueTV`` module\n\nEx.\n```\nfrom dizqueTV import API\n\ndtv = API(url=\"http://localhost:8000\")\n```\nEnable verbose logging by passing ``verbose=True`` into the ``API`` object declaration\n\n\n## Usage\n\nDocumentation available on [ReadTheDocs](https://dizquetv.readthedocs.io/en/latest/)\n\n### Exceptions\n- ``MissingSettingsError``: The kwargs you have provided to create a new object (ex. ``Channel`` or ``PlexServer``) are incomplete\n- ``MissingParametersError``: You did not provide a required parameter in your function call (ex. provide a PlexAPI Server when adding PlexAPI Video to a channel)\n- ``NotRemoteObjectError``: The object you are calling this method on is a locally-created object that does not exist on the dizqueTV server\n- ``ChannelCreationError``: An error occurred when creating a Channel object\n\n## Contact\nPlease leave a pull request if you would like to contribute.\n\nJoin the dizqueTV Discord server (link on [project page](https://github.com/vexorian/dizquetv)). My Discord username is **nwithan8#8438**\n\nFollow me on Twitter: [@nwithan8](https://twitter.com/nwithan8)\n\nAlso feel free to check out my other projects here on [GitHub](https://github.com/nwithan8) or join the #developer channel in my Discord server below.\n\n<div align=\"center\">\n\t<p>\n\t\t<a href=\"https://discord.gg/ygRDVE9\"><img src=\"https://discordapp.com/api/guilds/472537215457689601/widget.png?style=banner2\" alt=\"\" /></a>\n\t</p>\n</div>\n\n\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "Interact with a dizqueTV instance's API",
"version": "1.5.3.0",
"project_urls": {
"Download": "https://github.com/nwithan8/dizqueTV-python/archive/refs/tags/1.5.3.0.tar.gz",
"Homepage": "https://github.com/nwithan8/dizqueTV-python"
},
"split_keywords": [
"dizquetv",
"plex",
"jellyfin",
"emby",
"media",
"api",
"server",
"interaction",
"tv",
"television",
"streaming"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb674336b3ea496f2a8989415c8c1c7a97456857978245d917fc6470bc43cc38",
"md5": "245a2d59eb270570fc90174c9f50dc56",
"sha256": "99e796a5f1f54f743bfe45f886c1d20a889ee4e146d69b565209eeff648c6719"
},
"downloads": -1,
"filename": "dizqueTV-1.5.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "245a2d59eb270570fc90174c9f50dc56",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 65891,
"upload_time": "2023-11-29T03:53:07",
"upload_time_iso_8601": "2023-11-29T03:53:07.279565Z",
"url": "https://files.pythonhosted.org/packages/bb/67/4336b3ea496f2a8989415c8c1c7a97456857978245d917fc6470bc43cc38/dizqueTV-1.5.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fdd77c818323a39e99b6585c30da7f8fa44d703573046b545e9b32d9f0db72e",
"md5": "1d601683e6476d6d088622de4ed88abf",
"sha256": "6ac25d0bdcc51a951bf096ef655598a1424340e9986e9c60ca58f9e5d1cdb168"
},
"downloads": -1,
"filename": "dizqueTV-1.5.3.0.tar.gz",
"has_sig": false,
"md5_digest": "1d601683e6476d6d088622de4ed88abf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 60146,
"upload_time": "2023-11-29T03:53:09",
"upload_time_iso_8601": "2023-11-29T03:53:09.621104Z",
"url": "https://files.pythonhosted.org/packages/0f/dd/77c818323a39e99b6585c30da7f8fa44d703573046b545e9b32d9f0db72e/dizqueTV-1.5.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 03:53:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nwithan8",
"github_project": "dizqueTV-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dizquetv"
}