Merge pull request #179 from icesat2py/development

Release v0.3.3

Author: JessicaS11

.github/workflows/publish_to_pypi.yml

@@ -0,0 +1,62 @@
+# Publish archives to PyPI and TestPyPI using GitHub Actions
+name: Publish to PyPI
+
+# Only run for tagged releases and pushes to the development branch
+on:
+  release:
+    types:
+      - published
+  push:
+    branches:
+      - development
+  # Trigger manually at https://github.com/icesat2py/icepyx/actions/workflows/publish_to_pypi.yml
+  workflow_dispatch:
+
+jobs:
+  publish-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: github.repository == 'icesat2py/icepyx'
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2.3.4
+      with:
+        # fetch all history so that setuptools-scm works
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v2.2.1
+      with:
+        python-version: 3.9
+
+    - name: Install dependencies
+      run: python -m pip install setuptools wheel
+
+    # This step is only necessary for testing purposes and for TestPyPI
+    - name: Fix up version string for TestPyPI
+      if: ${{ !startsWith(github.ref, 'refs/tags') }}
+      run: |
+        # Change setuptools-scm local_scheme to "no-local-version" so the
+        # local part of the version isn't included, making the version string
+        # compatible with PyPI.
+        sed --in-place "s/node-and-date/no-local-version/g" setup.py
+
+    - name: Build source and wheel distributions
+      run: |
+        python setup.py sdist bdist_wheel
+        echo ""
+        echo "Generated files:"
+        ls -lh dist/
+
+    - name: Publish to Test PyPI
+      uses: pypa/gh-action-pypi-publish@v1.4.2
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+
+    - name: Publish to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@v1.4.2
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -24,6 +24,7 @@ wheels/
 .installed.cfg
 *.egg
 MANIFEST
+_icepyx_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.travis.yml

@@ -21,24 +21,3 @@ jobs:
     #   script:
     #     - export NSIDC_LOGIN=$NSIDC_LOGIN
     #     - pytest icepyx/tests/behind_NSIDC_API_login.py
-
-deploy:
-  - provider: pypi
-    server: https://test.pypi.org/legacy/ 
-    username: "__token__"
-    password: $test_PyPI_API_Token
-    on:
-      branch: development
-      if: commit_message =~ test_pypi
-    skip_existing: true
-    distributions: "sdist bdist_wheel"
-
-# NOTE: the API token on Travis must be set to ALL branches, because a tag build is not considered to be on the master branch: https://travis-ci.community/t/pypi-upload-with-api-token-not-working/5338/5
-  - provider: pypi
-    username: "__token__"
-    password: $PyPI_API_Token
-    on:
-      branch: master
-      tags: true
-    skip_existing: true
-    distributions: "sdist bdist_wheel"

CONTRIBUTORS.rst

@@ -23,5 +23,6 @@ order by last name) and are considered "The icepyx Developers":
 * `Ben Smith <https://github.com/smithb>`_ - University of Washington
 * `Amy Steiker <https://github.com/asteiker>`_ - NSIDC, University of Colorado
 * `Anna Valentine <https://github.com/annavalentine>`_ - Colorado School of Mines
+* `Bruce Wallin <https://github.com/wallinb>`_ - NSIDC, University of Colorado
 * `Molly Wieringa <https://github.com/mollymwieringa>`_ - University of Washington
 * `Bidhyananda Yadav <https://github.com/bidhya>`_ - Ohio State University

MANIFEST.in

@@ -0,0 +1,12 @@
+prune .github*
+prune doc*
+prune examples*
+prune icepyx/tests*
+exclude .coveragerc
+exclude .gitignore
+exclude .mailmap
+exclude *.ini
+exclude *.txt
+exclude *.yaml
+exclude *.yml
+include requirements.txt

doc/source/conf.py

@@ -58,6 +58,8 @@
 # location of master document (by default sphinx looks for contents.rst)
 master_doc = "index"
 
+# bibtex file
+bibtex_bibfiles = ["tracking/icepyx_pubs.bib"]
 
 # -- Configuration options ---------------------------------------------------
 autosummary_generate = True

icepyx/__init__.py

@@ -1 +1,3 @@
 from icepyx.core.query import Query
+
+from _icepyx_version import version as __version__

icepyx/core/APIformatting.py

@@ -251,6 +251,7 @@ def _get_possible_keys(self):
                     "token",
                     "email",
                     "include_meta",
+                    "client_string",
                 ],
             }
         elif self.partype == "subset":
@@ -341,7 +342,7 @@ def build_params(self, **kwargs):
             are time, bbox OR Boundingshape, format, projection, projection_parameters, and Coverage.
 
             Keyword argument inputs for 'CMR' may include: dataset, version, start, end, extent_type, spatial_extent
-            Keyword argument inputs for 'required' may include: page_size, page_num, request_mode, include_meta
+            Keyword argument inputs for 'required' may include: page_size, page_num, request_mode, include_meta, client_string
             Keyword argument inputs for 'subset' may include: geom_filepath, start, end, extent_type, spatial_extent
 
         """
@@ -352,7 +353,7 @@ def build_params(self, **kwargs):
             self._check_valid_keys()
 
         if self.partype == "required":
-            if self.check_req_values == True and kwargs == {}:
+            if self.check_req_values() and kwargs == {}:
                 pass
             else:
                 reqkeys = self.poss_keys[self._reqtype]
@@ -361,6 +362,7 @@ def build_params(self, **kwargs):
                     "page_num": 1,
                     "request_mode": "async",
                     "include_meta": "Y",
+                    "client_string": "icepyx"
                 }
                 for key in reqkeys:
                     if key in kwargs:

icepyx/core/Earthdata.py

@@ -45,16 +45,13 @@ def __init__(
     def _start_session(self):
         # Request CMR token using Earthdata credentials
         token_api_url = "https://cmr.earthdata.nasa.gov/legacy-services/rest/tokens"
-        hostname = socket.gethostname()
-        ip = socket.gethostbyname(hostname)
         # try initially with machine hostname
         # revert to using localhost if gaierror exception
         try:
             ip = socket.gethostbyname(socket.gethostname())
         except:
             ip = socket.gethostbyname("localhost")
 
-
         data = {
             "token": {
                 "username": self.uid,
@@ -66,7 +63,7 @@ def _start_session(self):
 
         response = None
         response = requests.post(
-            token_api_url, json=data, headers={"Accept": "application/json"}
+            token_api_url, json=data, headers={"Accept": "application/json", "Client-Id": "icepyx"}
         )
 
         # check for a valid login

icepyx/core/granules.py

@@ -148,7 +148,7 @@ def get_avail(self, CMRparams, reqparams):
 
         granule_search_url = "https://cmr.earthdata.nasa.gov/search/granules"
 
-        headers = {"Accept": "application/json"}
+        headers = {"Accept": "application/json", "Client-Id": "icepyx"}
         # DevGoal: check the below request/response for errors and show them if they're there; then gather the results
         # note we should also do this whenever we ping NSIDC-API - make a function to check for errors
         while True: