Merge pull request #119 from blaylockbk/use-uv-for-development

CHORE: Use uv for development and tests

Author: blaylockbk

.github/workflows/tests-python.yml

@@ -1,12 +1,10 @@
-name: Tests (Python)
+name: Tests (uv)
 
 on:
   push:
     branches: [main]
   pull_request:
     branches: [main]
-
-  # Allow job to be triggered manually.
   workflow_dispatch:
 
 # Cancel in-progress jobs when pushing to the same branch.
@@ -20,59 +18,41 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
-        # In order to save resources, only run particular
-        # matrix slots on other OS than Linux.
         include:
-          - os: "macos-latest"
-            python-version: "3.12"
-          - os: "windows-latest"
+          - os: ubuntu-latest
+            python-version: "3.10"
+          - os: ubuntu-latest
+            python-version: "3.11"
+          - os: ubuntu-latest
             python-version: "3.12"
+          - os: ubuntu-latest
+            python-version: "3.13"
+          - os: macos-latest
+            python-version: "3.13"
+            continue-on-error: true
+          - os: windows-latest
+            python-version: "3.13"
+            continue-on-error: true
 
-    env:
-      OS: ${{ matrix.os }}
-      PYTHON: ${{ matrix.python-version }}
-
-    defaults:
-      run:
-        shell: bash -el {0}
+    name: Python ${{ matrix.python-version }} • ${{ matrix.os }}
 
-    name: Python ${{ matrix.python-version }} on OS ${{ matrix.os }}
     steps:
-      - name: Acquire sources
+      - name: Checkout repository
         uses: actions/checkout@v4
         with:
           fetch-depth: 2
 
-      - name: Setup Python
-        uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
         with:
           python-version: ${{ matrix.python-version }}
-          architecture: x64
-          cache: "pip"
-          cache-dependency-path: "setup.cfg"
 
-      - name: Install project (Linux)
-        if: runner.os == 'Linux'
-        run: |
-          pip3 install --requirement=requirements-test.txt
-          pip3 install --editable=.
-
-      - name: Install project (macOS)
-        if: runner.os == 'macOS'
-        run: |
-          pip3 install --break-system-packages --requirement=requirements-test.txt
-          pip3 install --break-system-packages --editable=.
-
-      - name: Install project (Windows)
-        if: runner.os == 'Windows'
-        run: |
-          pip3 install --requirement=requirements-test.txt
-          pip3 install --editable=.
+      - name: Install the project
+        shell: bash -el {0}
+        run: uv sync
 
       - name: Run tests
+        shell: bash -el {0}
         env:
           TMPDIR: ${{ runner.temp }}
-        run: |
-          pytest
+        run: uv run pytest

.gitignore

@@ -1,7 +1,9 @@
+uv.lock
+
 # Don't upload ANY NetCDF files
 *.nc
 
-goes2go/_version.py
+src/goes2go/_version.py
 
 core.*
 

.readthedocs.yml

@@ -1,39 +1,31 @@
-# .readthedocs.yml
 # Read the Docs configuration file
 
 # Details
 # - https://docs.readthedocs.io/en/stable/config-file/v2.html
+# - https://github.com/astral-sh/uv/issues/10074
+# - https://docs.readthedocs.com/platform/stable/build-customization.html#install-dependencies-with-uv
 
 # Required
 version: 2
 
 build:
   os: "ubuntu-22.04"
   tools:
-    python: "3.10"
-  apt_packages:
-    - libgeos-dev
-
-  # Work around timeout error.
-  # ReadTimeoutError: HTTPSConnectionPool(host='files.pythonhosted.org', port=443): Read timed out.
-  # https://stackoverflow.com/questions/43298872/how-to-solve-readtimeouterror-httpsconnectionpoolhost-pypi-python-org-port#comment110786026_43560499
-  # https://github.com/readthedocs/readthedocs.org/issues/6311#issuecomment-1324426604
-  # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-jobs
+    python: "3.13"
   jobs:
-    post_checkout:
-      - echo "export PIP_DEFAULT_TIMEOUT=100" >> ~/.profile
+    create_environment:
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+      - uv venv
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --group docs
+    install:
+      - "true"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
-
 # Optionally build your docs in additional formats such as PDF
 formats:
   - pdf

README.md

@@ -122,7 +122,7 @@ G = GOES(satellite=17, product="GLM-L2-LCFA", domain='C')
 G = GOES(satellite=17, product="ABI-L1b-Rad", domain='F')
 ```
 
-> A complete listing of the products available are available [here](https://github.com/blaylockbk/goes2go/blob/main/goes2go/product_table.txt).
+> A complete listing of the products available are available [here](https://github.com/blaylockbk/goes2go/blob/main/src/goes2go/product_table.txt).
 
 There are methods to do the following:
 

docs/_build/html/_sources/index.rst.txt

@@ -86,7 +86,7 @@ First, create a GOES object to specify the satellite, data product, and domain y
    G = GOES(satellite=17, product="ABI-L1b-Rad", domain='F')
 
 
-.. note:: A complete listing of the products available are available at `here <https://github.com/blaylockbk/goes2go/blob/main/goes2go/product_table.txt>`_.
+.. note:: A complete listing of the products available are available at `here <https://github.com/blaylockbk/goes2go/blob/main/src/goes2go/product_table.txt>`_.
 
 There are methods to do the following: