Metadata-Version: 2.1
Name: pyombi
Version: 0.1.5
Summary: A python module to retrieve information from Ombi.
Home-page: https://github.com/larssont/pyombi
Author: Tommy Larsson
Author-email: larssont@tuta.io
License: UNKNOWN
Description: [![PyPI version](https://badge.fury.io/py/pyombi.svg)](https://badge.fury.io/py/pyombi)
        
        # pyombi
        
        This is a project for retrieving information from an Ombi instance using their API.
        
        
        # Installation
        
        Run the following to install:
        ```python
        pip install pyombi
        ```
        
        
        # Usage
        
        
        #### Creating an object of your Ombi instance
        ```python
        import pyombi
        
        ombi = pyombi.Ombi(
            ssl=True,
            host="192.168.1.120",
            port="5000",
            api_key="pixf64thuh2m7kbwwgkqp52yznbj4oyo",
            urlbase="ombi/",
            username="MyUsername"
        )
        ```
        
        #### Testing connection to Ombi
        
        ```python
        try:
            ombi.test_connection()
        except pyombi.OmbiError as e:
            print(e)
            return
        ```
        
        #### Retrieving data
        ```python
        movies = ombi.movie_requests
        tv = ombi.tv_requests
        music = ombi.music_requests
        
        total = ombi.total_requests
        ```
        
        #### Searching
        
        ```python
        movie_search = ombi.search_movie("Movie Name")  
        tv_search = ombi.search_tv("TV show name")
        music_search = ombi.search_music_album("Album name")
        ```
        
        #### Requesting
        ```python
        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.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
