Merge pull request #611 from icesat2py/development

release v1.3.0

.all-contributorsrc

@@ -470,6 +470,41 @@
       "contributions": [
         "ideas"
       ]
+    },
+    {
+      "login": "cclauss",
+      "name": "Christian Clauss",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3709715?v=4",
+      "profile": "https://github.com/cclauss",
+      "contributions": [
+        "maintenance",
+        "review",
+        "tool"
+      ]
+    },
+    {
+      "login": "jrenrut",
+      "name": "Jeremy Turner",
+      "avatar_url": "https://avatars.githubusercontent.com/u/42989238?v=4",
+      "profile": "https://github.com/jrenrut",
+      "contributions": [
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "mfisher87",
+      "name": "Matt Fisher",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3608264?v=4",
+      "profile": "https://mfisher87.github.io/",
+      "contributions": [
+        "bug",
+        "code",
+        "doc",
+        "maintenance",
+        "test",
+        "infra"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/actions/install-icepyx/action.yml

@@ -0,0 +1,19 @@
+name: 'Install icepyx'
+description: 'Install icepyx and dev dependencies'
+
+inputs:
+  python-version:
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - uses: "actions/setup-python@v5"
+      with:
+        python-version: "${{ inputs.python-version }}"
+
+    - name: "Install package and test dependencies"
+      shell: "bash"
+      run: |
+        python -m pip install .
+        python -m pip install -r requirements-dev.txt

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Keep GitHub Actions up to date with GitHub's Dependabot...
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    groups:
+      github-actions:
+        patterns:
+          - "*"  # Group all Actions updates into a single larger pull request
+    schedule:
+      interval: monthly

.github/workflows/get_pypi_stats.yml

@@ -16,7 +16,7 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         ref: "traffic"
 

.github/workflows/integration_test.yml

@@ -0,0 +1,49 @@
+name: "Integration test"
+# NOTE: We're just running the tests that require earthdata login here; we
+#       don't distinguish between unit and integration tests yet.
+
+on:
+  push:
+    branches:
+      - "main"  # Releases
+      - "development"  # Feature PR merges
+  pull_request:
+    branches:
+      - "main"  # Release PRs
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "The ref to test"
+        type: "string"
+
+
+jobs:
+  test:
+    name: "Integration test"
+    # Do not run on PRs from forks:
+    if: "${{ !github.event.pull_request.head.repo.fork }}"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 0
+          ref: "${{ inputs.ref }}"
+
+      - uses: "./.github/actions/install-icepyx"
+        with:
+          python-version: "3.12"
+
+      - name: "Run tests"
+        env:
+          EARTHDATA_PASSWORD: "${{ secrets.EARTHDATA_PASSWORD }}"
+          NSIDC_LOGIN: "${{ secrets.EARTHDATA_PASSWORD }}"
+        run: |
+          pytest icepyx/ --verbose --cov app \
+            icepyx/tests/test_behind_NSIDC_API_login.py \
+            icepyx/tests/test_auth.py
+
+      - name: "Upload coverage report"
+        uses: "codecov/[email protected]"
+        with:
+          token: "${{ secrets.CODECOV_TOKEN }}"

.github/workflows/publish_to_pypi.yml

@@ -22,13 +22,13 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
       with:
         # fetch all history so that setuptools-scm works
         fetch-depth: 0
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.9
 

.github/workflows/traffic_action.yml

@@ -17,13 +17,13 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
     # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
       with:
         ref: "traffic"
 
     # Calculates traffic and clones and stores in CSV file
     - name: GitHub traffic
-      uses: sangonzal/repository-traffic-action@v0.1.4
+      uses: sangonzal/repository-traffic-action@v.0.1.6
       env:
         TRAFFIC_ACTION_TOKEN: ${{ secrets.TRAFFIC_ACTION_TOKEN }}
 

.github/workflows/uml_action.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.ref }}
       - name: set up environment

.github/workflows/unit_test.yml

@@ -0,0 +1,40 @@
+name: "Unit test"
+# NOTE: We're just skipping the tests requiring earthdata login here; we don't
+#       distinguish yet between unit and integration tests.
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "main"
+      - "development"
+
+
+jobs:
+  test:
+    name: "Unit test (Python ${{ matrix.python-version }})"
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.12"] #NOTE: min and max Python versions supported by icepyx
+
+    steps:
+      - uses: "actions/checkout@v4"
+        with:
+          fetch-depth: 0
+
+      - uses: "./.github/actions/install-icepyx"
+        with:
+          python-version: "${{ matrix.python-version }}"
+
+      - name: "Run tests"
+        run: |
+          pytest icepyx/ --verbose --cov app \
+            --ignore=icepyx/tests/test_behind_NSIDC_API_login.py \
+            --ignore=icepyx/tests/test_auth.py
+
+      - name: "Upload coverage report"
+        uses: "codecov/[email protected]"
+        with:
+          token: "${{ secrets.CODECOV_TOKEN }}"

.pre-commit-config.yaml

@@ -6,17 +6,37 @@ repos:
       - id: check-yaml
       - id: check-added-large-files
         args: ["--maxkb=5000"]
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: debug-statements
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
       - id: end-of-file-fixer
+      - id: mixed-line-ending
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
+      - id: requirements-txt-fixer
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.3.0
+    hooks:
+      - id: codespell
+        additional_dependencies:
+          - tomli
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.5.7
+    rev: v0.6.3
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.19
+    hooks:
+      - id: validate-pyproject
+
 ci:
   autoupdate_schedule: monthly
 

ATTRIBUTION.rst

@@ -99,7 +99,7 @@ to identify core issues and propose solutions to challenges around software cred
 For software, current best practices (`e.g. <https://arxiv.org/pdf/2012.13117.pdf>`_) emphasize the importance of having a document
 such as this one to describe an individual community's policies for credit, authorship, and attribution.
 This document is an effort to describe icepyx's policies, with an awareness that they may change
-to accomodate community growth, best practices, and feedback.
+to accommodate community growth, best practices, and feedback.
 
 We do not attempt to identify contribution levels through the number of commits made to the repository (e.g. ``git shortlog -sne``)
 or active engagement on GitHub (e.g. through issues, discussions, and pull requests) and Discourse.