pyombi 0.1.10

A python module to retrieve information from Ombi.

pyombi

This is a project for retrieving information from an Ombi instance using their API.

Installation

Run the following to install:

pip install pyombi

Usage

Creating an object of your Ombi instance

Note: You have to supply either a password or an api_key to successfully authenticate. The api_key will take precedence if both are supplied.

import pyombi

ombi = pyombi.Ombi(
    ssl=True,
    host="192.168.1.120",
    port="5000",
    urlbase="ombi/",
    username="MyUsername",
    password="MyPassword",
    api_key="pixf64thuh2m7kbwwgkqp52yznbj4oyo"
)

Authenticate

ombi.authenticate()

Testing connection to Ombi

try:
    ombi.test_connection()
except pyombi.OmbiError as e:
    print(e)
    return

Retrieving data

movies = ombi.movie_requests
tv = ombi.tv_requests
music = ombi.music_requests

total = ombi.total_requests

Searching

movie_search = ombi.search_movie("Movie Name")  
tv_search = ombi.search_tv("TV show name")
music_search = ombi.search_music_album("Album name")

Requesting

ombi.request_movie("theMovieDbId")
ombi.request_tv("theTvDbId", request_latest=True)
ombi.request_music("foreignAlbumId")

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.