Merge pull request #16 from nasa/release/0.8.0

Release/0.8.0

Author: frankinspace

.github/workflows/codeql-analysis.yml

@@ -39,11 +39,11 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         with:
           languages: ${{ matrix.language }}
           # If you wish to specify custom queries, you can do so here or in a config file.
@@ -54,7 +54,7 @@ jobs:
       # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v1
+        uses: github/codeql-action/autobuild@v2
 
       # ℹ️ Command-line programs to run using the OS shell.
       # 📚 https://git.io/JvXDl
@@ -68,4 +68,4 @@ jobs:
       #   make release
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2

.github/workflows/python-app.yml

@@ -7,23 +7,23 @@ on:
   push:
     branches: [ develop ]
   pull_request:
-    branches: [ develop ]
+    branches: [ develop, main ]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python 3.10
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
       - name: Install Poetry
-        uses: abatilo/actions-poetry@v2.0.0
+        uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: 1.1.11
+          poetry-version: 1.5.1
       - name: Install dependencies
         run: |
           poetry run python -m pip install --upgrade pip

.github/workflows/python-publish.yml

@@ -18,15 +18,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
       - name: Install Poetry
-        uses: abatilo/actions-poetry@v2.0.0
+        uses: abatilo/actions-poetry@v2
         with:
-          poetry-version: 1.1.11
+          poetry-version: 1.5.1
       - name: Build package
         run: poetry build
       - name: Publish to pypi.org

CHANGELOG.md

@@ -7,6 +7,13 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [0.8.0]
+### Added
+- [pull/15](https://github.com/nasa/python_cmr/pull/15): New feature added to filter by granules within the circle around lat/lon
+- [pull/12](https://github.com/nasa/python_cmr/pull/12): Added environments to module level to simplify imports to `from cmr import CMR_UAT`
+### Changed
+- Changed token url to being tokens in authorization headers.
+- Add in bearer token function for use of EDL bearer token in authorization headers.
 
 ## [0.7.0]
 ### Added
@@ -31,8 +38,9 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 ## [Older]
 - Prior releases of this software originated from https://github.com/jddeal/python-cmr/releases
 
-[Unreleased]: https://github.com/nasa/python_cmr/compare/v0.7.0...HEAD
-[0.7.0]: https://github.com/nasa/python_cmr/compare/v0.6.0...0.7.0
+[Unreleased]: https://github.com/nasa/python_cmr/compare/v0.8.0...HEAD
+[0.8.0]: https://github.com/nasa/python_cmr/compare/v0.7.0...v0.8.0
+[0.7.0]: https://github.com/nasa/python_cmr/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/nasa/python_cmr/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/nasa/python_cmr/compare/ef0f9e7d67ce99d342a568bd6a098c3462df16d2...v0.5.0
-[Older]: https://github.com/jddeal/python-cmr/releases
+[Older]: https://github.com/jddeal/python-cmr/releases

README.md

@@ -99,6 +99,10 @@ The following methods are available to both collecton and granule queries:
 
     # search by provider
     >>> api.provider('POCLOUD')
+    
+    # search non-ops CMR environment
+    >>> from cmr import CMR_UAT
+    >>> api.mode(CMR_UAT)
 
 Granule searches support these methods (in addition to the shared methods above):
 
@@ -211,6 +215,14 @@ specified before making the request:
 
     >>> granules = api.format("echo10").get(100)
 
+We can add token to the api calls by setting headers using the following functions:
+
+    # Use token function for EDL echo-token or launchpad token
+    >>> api.token(token)
+
+    # Use bearer token function for EDL bearer tokens
+    >>> api.bearer_token(token)
+
 The following formats are supported for both granule and collection queries:
 
 - json (default)
@@ -280,4 +292,4 @@ poetry run flake8
 
 ```shell
 poetry run pytest
-```
+```

cmr/__init__.py

@@ -1,3 +1,3 @@
-from .queries import GranuleQuery, CollectionQuery, ToolQuery, ServiceQuery, VariableQuery
+from .queries import GranuleQuery, CollectionQuery, ToolQuery, ServiceQuery, VariableQuery, CMR_OPS, CMR_UAT, CMR_SIT
 
-__all__ = ["GranuleQuery", "CollectionQuery", "ToolQuery", "ServiceQuery", "VariableQuery"]
+__all__ = ["GranuleQuery", "CollectionQuery", "ToolQuery", "ServiceQuery", "VariableQuery", "CMR_OPS", "CMR_UAT", "CMR_SIT"]

cmr/queries.py

@@ -37,6 +37,7 @@ def __init__(self, route, mode=CMR_OPS):
         self._route = route
         self.mode(mode)
         self.concept_id_chars = []
+        self.headers = None
 
     def get(self, limit=2000):
         """
@@ -53,7 +54,7 @@ def get(self, limit=2000):
         page = 1
         while len(results) < limit:
 
-            response = get(url, params={'page_size': page_size, 'page_num': page})
+            response = get(url, headers=self.headers, params={'page_size': page_size, 'page_num': page})
 
             try:
                 response.raise_for_status()
@@ -83,7 +84,7 @@ def hits(self):
 
         url = self._build_url()
 
-        response = get(url, params={'page_size': 0})
+        response = get(url, headers=self.headers, params={'page_size': 0})
 
         try:
             response.raise_for_status()
@@ -273,18 +274,35 @@ def mode(self, mode=CMR_OPS):
 
     def token(self, token):
         """
-        Add token into url request.
+        Add token into authorization headers.
 
-        :param token: Token from EDL.
+        :param token: Token from EDL Echo-Token or NASA Launchpad token.
         :returns: Query instance
         """
 
         if not token:
             return self
 
-        self.params['token'] = token
+        self.headers = {'Authorization': token}
+
         return self
 
+    def bearer_token(self, bearer_token):
+        """
+        Add token into authorization headers.
+
+        :param token: Token from EDL token.
+        :returns: Query instance
+        """
+
+        if not bearer_token:
+            return self
+
+        self.headers = {'Authorization': 'Bearer ' + bearer_token}
+
+        return self
+
+
 class GranuleCollectionBaseQuery(Query):
     """
     Base class for Granule and Collection CMR queries.
@@ -417,6 +435,18 @@ def point(self, lon, lat):
 
         return self
 
+    def circle(self, lon: float, lat: float, dist: int):
+        """Filter by granules within the circle around lat/lon
+
+        :param lon: longitude of geographic point
+        :param lat: latitude of geographic point
+        :param dist: distance in meters around waypoint (lat,lon)
+        :returns: Query instance
+        """
+        self.params['circle'] = f"{lon},{lat},{dist}"
+
+        return self
+
     def polygon(self, coordinates):
         """
         Filter by granules that overlap a polygonal area. Must be used in combination with a