initial commit

Author: barrust

omdb/__init__.py

@@ -0,0 +1,12 @@
+
+from .omdb import OMDB
+from .exceptions import OMDBException, OMDBNoResults, OMDBLimitReached
+
+__author__ = 'Tyler Barrus'
+__maintainer__ = 'Tyler Barrus'
+__email__ = '[email protected]'
+__license__ = 'MIT'
+__version__ = '0.0.1'
+__url__ = 'https://github.com/barrust/pyomdbapi'
+__bugtrack_url__ = '{0}/issues'.format(__url__)
+__all__ = ['OMDB', 'OMDBException', 'OMDBNoResults', 'OMDBLimitReached']

omdb/exceptions.py

@@ -0,0 +1,42 @@
+
+
+class OMDBException(Exception):
+
+    def __init__(self, message):
+        self._message = message
+        super(OMDBException, self).__init__(self.message)
+
+    @property
+    def message(self):
+        ''' str: The MediaWiki exception message '''
+        return self._message
+
+
+class OMDBNoResults(OMDBException):
+
+    def __init__(self, error, params):
+        self._params = params
+        self._error = error
+        super(OMDBNoResults, self).__init__('message: {}\tparams: {}'.format(self._error, self._params))
+
+    @property
+    def error(self):
+        ''' str: The MediaWiki exception message '''
+        return self._message
+
+    @property
+    def params(self):
+        ''' str: The MediaWiki exception message '''
+        return self._params
+
+
+class OMDBLimitReached(OMDBException):
+
+    def __init__(self, api_key):
+        self._api_key = api_key
+        super(OMDBLimitReached, self).__init__('Limit reached for API Key: {}'.format(self._api_key))
+
+    @property
+    def api_key(self):
+        ''' str: The MediaWiki exception message '''
+        return self._api_key

omdb/omdb.py

@@ -0,0 +1,111 @@
+import requests
+
+from .exceptions import OMDBException, OMDBNoResults, OMDBLimitReached
+
+
+class OMDB(object):
+
+    def __init__(self, api_key, timeout=5):
+        self._api_url = 'https://www.omdbapi.com/'
+        self._timeout = timeout
+        self._api_key = api_key
+        self._session = requests.Session()
+
+    def close(self):
+        if self._session:
+            self._session.close()
+            self._session = None
+
+    def search(self, title, **params):
+        prms = {
+            's': title,
+            'apikey': self._api_key
+        }
+        prms.update(params)
+
+        data = self._get_response(prms)
+        return self.__format_results(data, prms)
+
+    def get(self, title=None, imdbid=None, **params):
+        prms = {
+            'apikey': self._api_key
+        }
+        if imdbid:
+            prms['i'] = imdbid
+        if title:
+            prms['t'] = title
+        else:
+            raise OMDBException("Either title or imdbid is required!")
+
+        prms.update(params)
+
+        data = self._get_response(prms)
+        return self.__format_results(data, prms)
+
+    def search_movie(self, title, **params):
+        prms = {'type': 'movie'}
+        prms.update(params)
+        data = self.search(title, **prms)
+        return self.__format_results(data, prms)
+
+    def search_series(self, title, **params):
+        prms = {'type': 'series'}
+        prms.update(params)
+        return self.search(title, **prms)
+
+    # def search_episode(self, title, **params):
+    #     prms = {'type': 'episode'}
+    #     prms.update(params)
+    #     return self.search(title, **prms)
+
+    def get_movie(self, title=None, imdbid=None, **params):
+        prms = {'type': 'movie'}
+        prms.update(params)
+        return self.get(title, imdbid, **prms)
+
+    def get_series(self, title=None, imdbid=None, **params):
+        prms = {'type': 'series'}
+        prms.update(params)
+        return self.get(title, imdbid, **prms)
+
+    def get_episode(self, title=None, imdbid=None, season=1, episode=1, **params):
+        prms = {'type': 'episode'}
+        if season:
+            prms['Season'] = season
+        if episode:
+            prms['Episode'] = episode
+        prms.update(params)
+        return self.get(title, imdbid, **prms)
+
+    def get_episodes(self, title=None, imdbid=None, season=1, **params):
+        return self.get_episode(title, imdbid, season, None, **params)
+
+    def _get_response(self, params):
+        return self._session.get(self._api_url, params=params,
+                                 timeout=self._timeout).json(encoding='utf8')
+
+    def __format_results(self, res, params):
+        if not isinstance(res, dict):
+            raise TypeError('Expecting dict type, recieved type(res)')
+
+        keys = res.keys()
+        for key in keys:
+            val = res.pop(key)
+            if isinstance(val, dict):
+                val = self.format_results(val)
+            if isinstance(val, list):
+                tmp = list()
+                for _, itm in enumerate(val):
+                    if isinstance(itm, dict):
+                        tmp.append(self.__format_results(itm))
+                    else:
+                        tmp.append(itm)
+                val = tmp
+
+            # convert camel case to lowercase
+            res[key.lower()] = val
+
+        if 'response' in res and res['response'] == 'False':
+            raise OMDBNoResults(res['error'], params)
+
+        return res

requirements/python

@@ -0,0 +1 @@
+requests

setup.cfg

@@ -0,0 +1,6 @@
+
+[PEP8]
+max-line-length=120
+
+[flake8]
+max-line-length=120

setup.py

@@ -0,0 +1,45 @@
+import setuptools
+import io
+from omdb import (__version__, __author__, __license__, __email__,
+                       __url__, __bugtrack_url__)
+
+KEYWORDS = ['python', 'omdb', 'omdb-api', 'API']
+
+def read_file(filepath):
+    ''' read the file '''
+    with io.open(filepath, 'r') as filepointer:
+        res = filepointer.read()
+    return res
+
+
+setuptools.setup(
+    name = 'pyomdbapi',  # mediawiki was taken
+    version = __version__,
+    author = __author__,
+    author_email = __email__,
+    description = 'OMDB API python wrapper',
+    license = __license__,
+    keywords = ' '.join(KEYWORDS),
+    url = __url__,
+    download_url = '{0}/tarball/v{1}'.format(__url__, __version__),
+    bugtrack_url = __bugtrack_url__,
+    install_requires = read_file('./requirements/python').splitlines(),
+    packages = ['omdb'],
+    long_description = read_file('README.md'),
+    classifiers = [
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Intended Audience :: Information Technology',
+        'Intended Audience :: Science/Research',
+        'Topic :: Software Development :: Libraries',
+        'Topic :: Utilities',
+        'Topic :: Internet',
+        'License :: OSI Approved',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.3',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6'
+    ]
+)