Allow query parameters

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Adds `--block-network` option to all test commands to ensure no network requests are made during unit tests
  [#119](https://github.com/stac-utils/pystac-client/pull/119)
+- `parameters` argument to `StacApiIO`, `Client.open`, and `Client.from_file` to allow query string parameters to be passed to all requests
+ [#118](https://github.com/stac-utils/pystac-client/pull/118)
 
 ### Fixed
 

pystac_client/client.py

@@ -27,10 +27,13 @@ def __repr__(self):
  return '<Client id={}>'.format(self.id)
 
  @classmethod
- def open(cls,
- url: str,
- headers: Dict[str, str] = None,
- ignore_conformance: bool = False) -> "Client":
+ def open(
+ cls,
+ url: str,
+ headers: Dict[str, str] = None,
+ parameters: Optional[Dict[str, Any]] = None,
+ ignore_conformance: bool = False,
+ ) -> "Client":
  """Opens a STAC Catalog or API
  This function will read the root catalog of a STAC Catalog or API
 
@@ -44,7 +47,7 @@ def open(cls,
  Return:
  catalog : A :class:`Client` instance for this Catalog/API
  """
- cat = cls.from_file(url, headers=headers)
+ cat = cls.from_file(url, headers=headers, parameters=parameters)
  search_link = cat.get_links('search')
  # if there is a search link, but no conformsTo advertised, ignore conformance entirely
  # NOTE: this behavior to be deprecated as implementations become conformant
@@ -54,17 +57,20 @@ def open(cls,
  return cat
 
  @classmethod
- def from_file(cls,
- href: str,
- stac_io: Optional[pystac.StacIO] = None,
- headers: Optional[Dict] = {}) -> "Client":
+ def from_file(
+ cls,
+ href: str,
+ stac_io: Optional[pystac.StacIO] = None,
+ headers: Optional[Dict] = {},
+ parameters: Optional[Dict] = None,
+ ) -> "Client":
  """Open a STAC Catalog/API
 
  Returns:
  Client: A Client (PySTAC Catalog) of the root Catalog for this Catalog/API
  """
  if stac_io is None:
- stac_io = StacApiIO(headers=headers)
+ stac_io = StacApiIO(headers=headers, parameters=parameters)
 
  cat = super().from_file(href, stac_io)
 

pystac_client/stac_api_io.py

@@ -36,18 +36,27 @@
 
 
 class StacApiIO(DefaultStacIO):
- def __init__(self, headers: Optional[Dict] = None, conformance: Optional[List[str]] = None):
+ def __init__(
+ self,
+ headers: Optional[Dict] = None,
+ conformance: Optional[List[str]] = None,
+ parameters: Optional[Dict] = None,
+ ):
  """Initialize class for API IO
 
  Args:
  headers : Optional dictionary of headers to include in all requests
+ conformance : Optional list of `Conformance Classes
+ <https://github.com/radiantearth/stac-api-spec/blob/master/overview.md#conformance-classes>`__.
+ parameters: Optional dictionary of query string parameters to include in all requests.
 
  Return:
  StacApiIO : StacApiIO instance
  """
  # TODO - this should super() to parent class
  self.session = Session()
  self.session.headers.update(headers or {})
+ self.session.params.update(parameters or {})
 
  self._conformance = conformance