Merge pull request #855 from planetlabs/subscription-request-api

Implement subscription request helper methods in python api

Author: jreiberkyle

docs/python/sdk-reference.md

@@ -26,6 +26,14 @@ title: Python SDK API Reference
     rendering:
       show_root_full_path: false
 
+## ::: planet.SubscriptionsClient
+    rendering:
+      show_root_full_path: false
+
+## ::: planet.subscription_request
+    rendering:
+      show_root_full_path: false
+
 ## ::: planet.reporting
     rendering:
       show_root_full_path: false

planet/__init__.py

@@ -13,18 +13,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 from .http import Session
-from . import order_request, reporting
+from . import data_filter, order_request, reporting, subscription_request
 from .__version__ import __version__  # NOQA
 from .auth import Auth
-from .clients import DataClient, OrdersClient  # NOQA
+from .clients import DataClient, OrdersClient, SubscriptionsClient  # NOQA
 from .io import collect
 
 __all__ = [
     'Auth',
     'collect',
-    'DataClient'
+    'DataClient',
+    'data_filter',
     'OrdersClient',
     'order_request',
     'reporting',
     'Session',
+    'SubscriptionsClient',
+    'subscription_request'
 ]

planet/clients/__init__.py

@@ -14,8 +14,6 @@
 # limitations under the License.
 from .data import DataClient
 from .orders import OrdersClient
+from .subscriptions import SubscriptionsClient
 
-__all__ = [
-    'DataClient',
-    'OrdersClient',
-]
+__all__ = ['DataClient', 'OrdersClient', 'SubscriptionsClient']

planet/order_request.py

@@ -34,7 +34,7 @@ def build_request(name: str,
     '''Prepare an order request.
 
     ```python
-    >>> from planet.api.order_details import (
+    >>> from planet.order_request import (
     ...     build_request, product, toar_tool, reproject_tool, tile_tool)
     ...
     >>> products = [
@@ -332,7 +332,7 @@ def clip_tool(aoi: dict) -> dict:
         aoi: clip GeoJSON, either Polygon or Multipolygon.
 
     Raises:
-        geojson.GeoJSONException: If GeoJSON is not a valid polygon or
+        planet.exceptions.ClientError: If GeoJSON is not a valid polygon or
             multipolygon.
     '''
     valid_types = ['Polygon', 'MultiPolygon']
@@ -421,7 +421,7 @@ def tile_tool(tile_size: int,
     return _tool('tile', parameters)
 
 
-def toar_tool(scale_factor: Optional[int] = None, ) -> dict:
+def toar_tool(scale_factor: Optional[int] = None) -> dict:
     '''Create the API spec representation of a TOAR tool.
 
     Parameters:
@@ -439,9 +439,19 @@ def toar_tool(scale_factor: Optional[int] = None, ) -> dict:
 def harmonize_tool(target_sensor: str) -> dict:
     '''Create the API spec representation of a harmonize tool.
 
-    Currently, only "PS2" (Dove Classic) and "Sentinel-2" are supported as
-    target sensors. The Sentinel-2 target only harmonizes PSScene
-    surface reflectance bundle types (analytic_8b_sr_udm2, analytic_sr_udm2).
-    The PS2 target only works on analytic bundles from Dove-R (PS2.SD).
+    Parameters:
+        target_sensor: A value indicating to what sensor the input asset types
+            should be calibrated.
+
+    Raises:
+        planet.exceptions.ClientError: If target_sensor is not valid.
     '''
+
+    try:
+        target_sensor = specs.get_match(target_sensor,
+                                        specs.HARMONIZE_TOOL_TARGET_SENSORS,
+                                        'target_sensor')
+    except specs.SpecificationException as e:
+        raise ClientError(e)
+
     return _tool('harmonize', {'target_sensor': target_sensor})

planet/specs.py

@@ -33,6 +33,7 @@
 SUPPORTED_ORDER_TYPES = ['full', 'partial']
 SUPPORTED_ARCHIVE_TYPES = ['zip']
 SUPPORTED_FILE_FORMATS = ['COG', 'PL_NITF']
+HARMONIZE_TOOL_TARGET_SENSORS = ('Sentinel-2', 'PS2')
 
 LOGGER = logging.getLogger(__name__)