Merge pull request #6 from bgr/refreshment

Switch to OMDB API, Python 3 support, PEP-8 fixes

Author: bgr

README.md

@@ -1,91 +1,117 @@
-*NIX command line tool for retrieving IMDb movie information
-============================================================
-
-### Usage:
-
-First set up an alias for the command:
-
-    alias imdbtool="python /path/to/imdbtool.py"
-
-### Some interesting usage examples:
-
-Show all info about movie 'Cars'
-
-    imdbtool -t Cars
-
-Show all info about latest 'True Grit' movie
-
-    imdbtool -t "True Grit"
-    
-Show all info about 1969 version of 'True Grit'
-
-    imdbtool -t "True Grit" -y 1969
-    
-Show best guess for a misspelled name
-
-    imdbtool -t "Ture git"
-    
-Print movie's rating
-
-    imdbtool -t Cars | sed -n '/^imdbrating/{n;p;}'
-    
-Download movie's poster
-
-    imdbtool -t Cars | wget `sed -n '/^poster/{n;p;}'`
-
-    
-### Additional useful features:
-
-Include full plot summary (not available for some movies)
-
-    imdbtool -t "True Grit" --plot full
-    
-Include additional data from Rotten Tomatoes
-
-    imdbtool -t "True Grit" --tomatoes
-
-Show info by IMDb id
-
-    imdbtool -i tt0103064
-    
-Print raw JSON or XML data
-
-    imdbtool -t Cars -r JSON
-    
-
-### Example to get ratings for all movies in current directory (it will use directory and file names as movie titles):
-
-Save following code to file `get_ratings.sh` (make sure to update the path in line 3):
-
-    ls -1 | 
-    while read title; do
-      res=`python /path/to/imdbtool.py -t "$title"`
-      rating=`echo "$res" | sed -n '/^imdbrating/{n;p;}'`
-      restitle=`echo "$res" | sed -n '/^title/{n;p;}' | sed s/*//g`
-      year=`echo "$res" | sed -n '/^year/{n;p;}'`
-      echo "$title  *  $restitle  *  $year  *  $rating"
-    done
-
-Then execute the saved command to fetch all the ratings: `./get_ratings.sh > ratings.txt`
-(it'll take a while to retrieve all the data). Then you can open the `ratings.txt` file to see the movie ratings, or you can sort the movies by ratings to pick the best one to watch: `< ratings.txt sort -t* -k4 -r`
-    
-    
-## Notes ##
-
- - requires Python 2.7+ (or earlier with installed argparse package)
- - for using it on Windows with Cygwin (which currently comes with Python 2.6) check out [this guide][cyg27]
- - **thanks to creator of this [great site called IM-D-BAPI][imdbapi]**
- 
-I was aware of [this existing tool][fetcher] but unfortunately it was broken at the time I tried it. My implementation relies on the third-party API that handles up to 2 million queries a day, so it's safe to assume that it's author will be keeping it up to date. 
-On the other hand, IMDb has jumped onto the douchebag bandwagon and issued a cease and desist order to the creator of the [IMDBAPI][imdbapi], so it might stop working any time.
-
-
-## License ##
-
-This tool is licensed under [GNU Lesser GPL][lgpl] license.
-
-
-[imdbapi]: http://www.imdbapi.com
-[cyg27]: http://www.tux.org/~mayer/cygwin/python/index.html
-[fetcher]: http://www.mutexes.org/imdb-movie-fetcher/
-[lgpl]: http://www.gnu.org/licenses/lgpl.html
+*NIX command line and GUI tool for retrieving OMDb movie/TV information
+============================================================
+
+### Usage:
+
+First set up an alias for the command:
+
+    alias omdbtool="python /path/to/omdbtool.py"
+
+Or for the gui:
+
+    alias omdbtool="python /path/to/omdbtool-gui.py"
+
+Note: in order to use the gui you will need to install [Gooey][gooey]
+
+    pip install Gooey
+
+### Some interesting usage examples:
+
+Show all info about the movie 'Cars'
+
+    omdbtool -t Cars
+
+Show all info about the series 'Firefly'
+
+    omdbtool -t firefly --type series
+
+Show all info about season 1 episode 1 of 'Firefly'
+
+    omdbtool -t firefly --season 1 --episode 1
+
+Show all info about season 1 of 'Firefly'
+
+    omdbtool -r JSON -t firefly --season 1
+
+Show all info about latest 'True Grit' movie
+
+    omdbtool -t "True Grit"
+
+Show all info about 1969 version of 'True Grit'
+
+    omdbtool -t "True Grit" -y 1969
+
+Show best guess for a misspelled name
+
+    omdbtool -t "Ture git"
+
+Print movie's rating
+
+    omdbtool -t Cars | sed -n '/^imdbrating/{n;p;}'
+
+Download movie's poster
+
+    omdbtool -t Cars | wget `sed -n '/^poster/{n;p;}'`
+
+
+### Additional useful features:
+
+Include full plot summary (not available for some movies)
+
+    omdbtool -t "True Grit" --plot full
+
+Include additional data from Rotten Tomatoes
+
+    omdbtool -t "True Grit" --tomatoes
+
+Show info by IMDb id
+
+    omdbtool -i tt0103064
+
+Print raw JSON or XML data
+
+    omdbtool -t Cars -r JSON
+
+Print data formated as html
+
+    omdbtool --format html -t cars
+
+Print data formated as markdown
+
+    omdbtool --format markdown -t cars
+
+
+
+### Example to get ratings for all movies in current directory
+
+(it will use directory and file names as movie titles)
+
+Save following code to file `get_ratings.sh` (make sure to update the path in line 3):
+
+    ls -1 |
+    while read title; do
+      res=`python /path/to/omdbtool.py -t "$title"`
+      rating=`echo "$res" | sed -n '/^imdbrating/{n;p;}'`
+      restitle=`echo "$res" | sed -n '/^title/{n;p;}' | sed s/*//g`
+      year=`echo "$res" | sed -n '/^year/{n;p;}'`
+      echo "$title  *  $restitle  *  $year  *  $rating"
+    done
+
+Then execute the saved command to fetch all the ratings: `./get_ratings.sh > ratings.txt`
+(it'll take a while to retrieve all the data). Then you can open the `ratings.txt` file to see the movie ratings, or you can sort the movies by ratings to pick the best one to watch: `< ratings.txt sort -t* -k4 -r`
+
+
+## Notes ##
+
+ - works with Python 3 and Python 2.7 or earlier with argparse package installed
+ - **thanks to the creator of this [great site called OMDBAPI][omdbapi]**
+
+
+## License ##
+
+This tool is licensed under [GNU Lesser GPL][lgpl] license.
+
+
+[omdbapi]: http://www.omdbapi.com
+[lgpl]: http://www.gnu.org/licenses/lgpl.html
+[gooey]: https://github.com/chriskiehl/Gooey

TODO.md

@@ -0,0 +1,11 @@
+Fix CSV output 
+
+Add a output file option
+
+Added -v for the api version (The only api out right now is V1 but V2 seems to be on it's way)
+
+Clean up the code
+
+Package both packages into exes with pyinstaller
+
+Add some custom icons

imdbtool.py

@@ -0,0 +1,86 @@
+
+import argparse
+import urllib
+import sys
+import json
+from gooey import Gooey
+from gooey import GooeyParser
+@Gooey      
+def main():
+  parser = argparse.ArgumentParser(description='Get OMDb data for a movie')
+  parser.add_argument("-t", help="Movie title")
+  parser.add_argument("-y", help="Year of release", type=int)
+  parser.add_argument("-i", help="IMDb movie id")
+  parser.add_argument("-r", help="Return raw XML/JSON response", choices=['JSON','XML'])
+  parser.add_argument("--plot", help="Length of plot summary", choices=['short','full'])
+  parser.add_argument("--tomatoes", help="Include Rotten Tomatoes data too", action="store_true")
+  parser.add_argument("--type", help="movie, series, episode", choices=['movie','series','episode'])
+  parser.add_argument("--season", help="season number", type=int)
+  parser.add_argument("--episode", help="episode number", type=int)
+  parser.add_argument("--format", help="Output formated in html, markdown or csv, leave out for text", choices=['html','markdown','csv'])
+  args = parser.parse_args()
+
+  params = {}
+  keys = ['t', 'y', 'i', 'plot', 'r', 'tomatoes','type','season','episode']
+
+  for k in keys:
+    if args.__getattribute__(k): params[k] = args.__getattribute__(k)
+
+  if len(params) == 0:
+    parser.print_usage()
+    sys.exit()
+
+
+  ### call OMDb API
+
+  apicall = urllib.urlopen('https://www.omdbapi.com/?%s' % urllib.urlencode(params))
+  result = apicall.read()
+  apicall.close()
+
+  # print raw output and exit, if raw output was requested
+  if args.r:
+    print result
+    sys.exit()
+  if args.format == 'csv':
+    result = result.replace('","', ',')
+    chars_to_remove = ['"','[',']','{','}']
+    result = result.translate(None, ''.join(chars_to_remove))
+    print result
+    sys.exit()
+  # formats data as html
+  elif args.format == 'html':
+    result = result.replace('",', '<br>')
+    result = result.replace('{','<br><br><br><p>')
+    chars_to_remove = ['"','[',']']
+    result = result.translate(None, ''.join(chars_to_remove))
+    result = result.replace('}','</p>')
+    print result
+    sys.exit()
+
+  # formats the data as markdown
+  if args.format == 'markdown':
+    result = result.replace('",', '\n')
+    result = result.replace('{','##')
+    chars_to_remove = ['"','[',']','}']
+    result = result.translate(None, ''.join(chars_to_remove))
+    print result
+    sys.exit()
+  
+  # Encoding the data from --season option crashs the program this prints the data with out having to encode it
+  if args.season:
+    chars_to_remove = ['"', '[', ']','}']
+    result = result.translate(None, ''.join(chars_to_remove))
+    result = result.replace(',', '\n')
+    result = result.replace('{','\n\n\n')
+    print result
+    sys.exit()
+  # print requested info
+
+  data = json.loads(result)
+  for k in data:
+    print k.lower() + ":"
+    print data[k].encode('utf-8')
+    print "\n"
+
+if __name__ == '__main__':
+  main()