Merge pull request #123 from developmentseed/json

adds bare json support for search #96
developmentseed · Oct 27, 2015 · a4b1dcc · a4b1dcc
2 parents 8f97f06 + 973abe2
commit a4b1dcc
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 2 deletions.
diff --git a/docs/commands.rst b/docs/commands.rst
@@ -35,6 +35,8 @@ Commands
                     -c CLOUD, --cloud CLOUD
                                         Maximum cloud percentage. Default: 20 perct
 
+                    --json              Returns a bare JSON response
+
                     -h, --help          Show this help message and exit
 
             Download:

diff --git a/docs/overview.rst b/docs/overview.rst
@@ -36,6 +36,9 @@ Search by latitude and longitude::
 
     $: landsat search --lat 38.9004204 --lon -77.0237117
 
+Search by latitude and longitude with pure json output::
+
+    $: landsat search --lat 38.9004204 --lon -77.0237117 --json
 
 Download
 ++++++++

diff --git a/landsat/landsat.py b/landsat/landsat.py
@@ -3,6 +3,7 @@
 # Landsat Util
 # License: CC0 1.0 Universal
 
+import sys
 import argparse
 import textwrap
 import json
@@ -56,6 +57,8 @@
                 -c CLOUD, --cloud CLOUD
                                     Maximum cloud percentage. Default: 20 perct
 
+                --json              Returns a bare JSON response
+
                 -h, --help          Show this help message and exit
 
         Download:
@@ -181,6 +184,7 @@ def args_options():
                                'Example: path,row,path,row 001,001,190,204')
     parser_search.add_argument('--lat', type=float, help='The latitude')
     parser_search.add_argument('--lon', type=float, help='The longitude')
+    parser_search.add_argument('--json', action='store_true', help='Returns a bare JSON response')
 
     parser_download = subparsers.add_parser('download',
                                             help='Download images from Google Storage')
@@ -313,6 +317,9 @@ def main(args):
                               cloud_max=args.cloud)
 
             if result['status'] == 'SUCCESS':
+                if args.json:
+                    return json.dumps(result)
+
                 if args.latest > 0:
                     datelist = []
                     for i in range(0, result['total_returned']):
@@ -431,8 +438,12 @@ def __main__():
     global parser
     parser = args_options()
     args = parser.parse_args()
-    with timer():
-        exit(*main(args))
+    if args.json:
+        print main(args)
+        sys.exit(0)
+    else:
+        with timer():
+            exit(*main(args))
 
 if __name__ == "__main__":
     try:

diff --git a/tests/test_landsat.py b/tests/test_landsat.py
@@ -3,6 +3,7 @@
 
 """Tests for landsat"""
 
+import json
 import unittest
 import subprocess
 import errno
@@ -67,6 +68,15 @@ def test_search_pr_wrong_input(self):
         self.assertEquals(landsat.main(self.parser.parse_args(args)),
                           ['Check your request and try again', 1])
 
+    def test_search_json_output(self):
+        """Test json output in search"""
+        args = ['search', '--latest', '10', '--json']
+
+        output = landsat.main(self.parser.parse_args(args))
+        j = json.loads(output)
+
+        self.assertEquals(type(j), dict)
+
     @mock.patch('landsat.landsat.Downloader')
     def test_download_correct(self, mock_downloader):
         """Test download command with correct input"""