Update github actions

Author: nodohs

.github/workflows/python-package.yml

@@ -9,8 +9,32 @@ on:
   pull_request:
     branches: ['main']
 
+permissions:
+  contents: read
+
 jobs:
+  ruff:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+      - name: Set up Python 3.14
+        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
+        with:
+          python-version: '3.14'
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - name: Install Ruff
+        run: python -m pip install --upgrade pip ruff
+      - name: Ruff check
+        run: ruff check .
+      - name: Ruff format check
+        run: ruff format --check .
+
   build:
+    needs: ruff
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -20,20 +44,18 @@ jobs:
 
     steps:
       - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
         with:
           python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install .[test,nldi]
-      - name: Lint with flake8
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
       - name: Test with pytest and report coverage
         run: |
           coverage run -m pytest tests/

.github/workflows/python-publish.yml

@@ -17,24 +17,23 @@ permissions:
 
 jobs:
   deploy:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
-    - name: Set up Python
-      uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-        pip install setuptools setuptools-scm wheel twine check-manifest
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
+      - name: Set up Python 3.13
+        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
+        with:
+          python-version: '3.13'
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - name: Install build tooling
+        run: |
+          python -m pip install --upgrade pip build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/sphinx-docs.yml

@@ -4,6 +4,7 @@ name: Sphinx Docs Build
 
 on:
   push:
+    branches: ['main']
   pull_request:
 
 jobs:
@@ -14,21 +15,20 @@ jobs:
         uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871
         with:
           persist-credentials: false
-      - name: Install dataretrieval, dependencies, and Sphinx then build docs
-        shell: bash -l {0}
+      - name: Set up Python 3.13
+        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3
+        with:
+          python-version: '3.13'
+          cache: pip
+          cache-dependency-path: pyproject.toml
+      - name: Install documentation dependencies
         run: |
           python -m pip install --upgrade pip
           pip install .[doc,nldi]
           ipython kernel install --name "python3" --user
-          sudo apt update -y && sudo apt install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended dvipng pandoc
+          sudo apt-get update -y
+          sudo apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended dvipng pandoc
           (cd docs && make html)
-      - name: Debug
-        run: |
-          echo $REF
-          echo $EVENT_NAME
-          echo ${{ github.event_name == 'push' }}
-          echo ${{ github.ref == 'refs/heads/main' }}
-          echo ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
       - name: Deploy to GitHub Pages
         uses: JamesIves/github-pages-deploy-action@881db5376404c5c8d621010bcbec0310b58d5e29
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}

docs/source/meta/installing.rst

@@ -4,13 +4,11 @@ Installation Guide
 Whether you are a user or developer we recommend installing ``dataretrieval``
 in a virtual environment. This can be done using something like ``virtualenv``
 or ``conda``. Package dependencies are listed in the `requirements.txt`_ file,
-a full list of dependencies necessary for development are listed in the
-`requirements-dev.txt`_ file.
+a full list of dependencies necessary for development are available from the
+``dev`` extra in ``pyproject.toml``.
 
 .. _requirements.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/main/requirements.txt
 
-.. _requirements-dev.txt: https://github.com/DOI-USGS/dataretrieval-python/blob/main/requirements-dev.txt
-
 
 User Installation
 -----------------
@@ -59,8 +57,7 @@ the package for development:
 
 .. code-block:: bash
 
-    $ pip install -r requirements-dev.txt
-    $ pip install -e .
+    $ pip install -e ".[dev]"
 
 To check your installation you can run the tests with the following commands:
 

pyproject.toml

@@ -36,7 +36,6 @@ test = [
   "pytest-cov[all]",
   "coverage",
   "requests-mock",
-  "flake8",
 ]
 doc = [
   "docutils<0.22",
@@ -52,6 +51,23 @@ doc = [
 nldi = [
   'geopandas>=0.10'
 ]
+dev = [
+  "pytest > 5.0.0",
+  "pytest-cov[all]",
+  "coverage",
+  "requests-mock",
+  "ruff",
+  "docutils<0.22",
+  "sphinx",
+  "sphinx-rtd-theme",
+  "nbsphinx",
+  "nbsphinx_link",
+  "ipython",
+  "ipykernel",
+  "matplotlib",
+  "folium>=0.12",
+  "geopandas>=0.10",
+]
 
 [project.urls]
 homepage = "https://github.com/DOI-USGS/dataretrieval-python"