README.md

dizqueTV-python

A Python library to interact with a 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

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). My Discord username is nwithan8#8438

Follow me on Twitter: @nwithan8

Also feel free to check out my other projects here on GitHub or join the #developer channel in my Discord server below.