Adopt PEP 517 and PEP 621, use raven-hydro package

.github/workflows/main.yml

@@ -30,61 +30,110 @@ jobs:
         run: tox -e black
 
   pip:
-    name: Pip with Python${{ matrix.python-version }}
+    name: Python${{ matrix.python-version }} (${{ matrix.os }})
     needs: black
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
         include:
           - tox-env: py38
             python-version: "3.8"
-          - tox-env: py39-numpy
+            os: ubuntu-latest
+            allow-errors: false
+          - tox-env: py39
             python-version: "3.9"
+            os: ubuntu-latest
+            allow-errors: false
+          - tox-env: py310
+            python-version: "3.10"
+            os: ubuntu-latest
+            allow-errors: false
+          - tox-env: py311
+            python-version: "3.11"
+            os: ubuntu-latest
+            allow-errors: false
           - tox-env: py310
             python-version: "3.10"
+            os: macos-latest
+            allow-errors: true
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install GDAL
+
+    - name: Install GDAL (Ubuntu)
+      if: matrix.os == 'ubuntu-latest'
       run: |
         sudo apt-get update
         sudo apt-get install libgdal-dev
-    - name: Install tox and setuptools
+    - name: Install GDAL (macOS)
+      if: matrix.os == 'macos-latest'
+      uses: tecolicom/actions-use-homebrew-tools@v1
+      with:
+        tools: gdal
+        cache: yes
+    - name: Set GDAL_VERSION (Ubuntu)
+      if: matrix.os == 'ubuntu-latest'
+      run: |
+        echo "GDAL_VERSION=$(gdal-config --version)" >> $GITHUB_ENV
+    - name: Set GDAL_VERSION (macOS)
+      if: matrix.os == 'macos-latest'
+      run: |
+        echo "GDAL_VERSION=$(gdalinfo --version | awk  '{print $2}' | sed s'/.$//')" >> $GITHUB_ENV
+
+    - name: Install tox
       run: |
         pip install tox~=4.0
-        pip install --upgrade "setuptools<65.6"
     - name: Test with tox and report coverage
-      run: env GDAL_VERSION="$(gdal-config --version)" tox -e ${{ matrix.tox-env }}
+      run: |
+        python3 -m tox -e ${{ matrix.tox-env }}
+      continue-on-error: ${{ matrix.allow-errors }}
       env:
-        LD_PRELOAD: /lib/x86_64-linux-gnu/libstdc++.so.6  # :"$LD_PRELOAD"
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         COVERALLS_FLAG_NAME: run-${{ matrix.tox-env }}
         COVERALLS_PARALLEL: true
 
   conda:
-    name: Conda
+    name: Python${{ matrix.python-version }} (${{ matrix.os }}) (Conda)
     needs: black
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            python-version: "3.9"
+          - os: ubuntu-latest
+            python-version: "3.10"
+          - os: ubuntu-latest
+            python-version: "3.11"
+          - os: macos-latest
+            python-version: "3.9"
     defaults:
       run:
         shell: bash -l {0}
     steps:
       - uses: actions/checkout@v3
-      - name: Setup Conda (Micromamba) with Python3.9
-        uses: mamba-org/provision-with-micromamba@main
+      - name: Patch Environment File
+        if: matrix.os == 'windows-latest'
+        run: |
+          sed -i 's/climpred >=2.2.0/xesmf/' environment.yml
+      - name: Setup Conda (Micromamba) with Python${{ matrix.python-version }}
+        uses: mamba-org/setup-micromamba@v1
         with:
           cache-downloads: true
+          cache-environment: true
           environment-file: environment.yml
-          extra-specs: |
-            mamba
-            pip<23.1
-            python=3.9
+          create-args: >-
+            conda
+            python=${{ matrix.python-version }}
       - name: Conda and Mamba versions
         run: |
-          mamba --version
+          conda --version
+          echo "micromamba: $(micromamba --version)"
       - name: Install RavenPy
         run: |
           pip install -e ".[dev]"

.pre-commit-config.yaml

@@ -6,31 +6,33 @@ repos:
     rev: v3.4.0
     hooks:
       - id: pyupgrade
-        args: [ --py38-plus ]
+        args: [ '--py38-plus' ]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
     hooks:
       - id: trailing-whitespace
-        exclude: .rvc|.rvh|.rvi|.rvp|.rvt|.tpl|.txt|setup.cfg
       - id: end-of-file-fixer
-        exclude: .ipynb|.rvc|.rvh|.rvi|.rvp|.rvt|.tpl|.txt
       - id: check-json
+      - id: check-toml
       - id: check-yaml
-        args: [ --allow-multiple-documents ]
+        args: [ '--allow-multiple-documents' ]
+      - id: debug-statements
       - id: pretty-format-json
         args: [ '--autofix', '--no-ensure-ascii', '--no-sort-keys' ]
-      - id: debug-statements
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:
       - id: python-check-blanket-noqa
       - id: rst-inline-touching-normal
+  - repo: https://github.com/pappasam/toml-sort
+    rev: v0.23.0
+    hooks:
+      - id: toml-sort-fix
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
       - id: black
         exclude: ^docs/
-        args: [ --target-version=py38 ]
   - repo: https://github.com/pycqa/flake8
     rev: 6.0.0
     hooks:
@@ -40,19 +42,16 @@ repos:
     rev: 5.12.0
     hooks:
       - id: isort
-        args: [ --settings-file=setup.cfg ]
   - repo: https://github.com/nbQA-dev/nbQA
     rev: 1.7.0
     hooks:
       - id: nbqa-pyupgrade
         args: [ --py38-plus ]
-        additional_dependencies: [ pyupgrade==3.3.1 ]
+        additional_dependencies: [ 'pyupgrade==3.3.1' ]
       - id: nbqa-black
-        args: [ --target-version=py38 ]
-        additional_dependencies: [ black==23.3.0 ]
+        additional_dependencies: [ 'black==23.3.0' ]
       - id: nbqa-isort
-        args: [ --settings-file=setup.cfg ]
-        additional_dependencies: [ isort==5.12.0 ]
+        additional_dependencies: [ 'isort==5.12.0' ]
   - repo: https://github.com/pycqa/pydocstyle
     rev: 6.3.0
     hooks:
@@ -62,16 +61,12 @@ repos:
     rev: v0.3.8
     hooks:
       - id: blackdoc
-        additional_dependencies: [ black==23.3.0 ]
+        additional_dependencies: [ 'black==23.3.0' ]
   - repo: https://github.com/adrienverge/yamllint.git
     rev: v1.32.0
     hooks:
       - id: yamllint
-        args: [ '--config-file', '.yamllint.yaml' ]
-  - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.49"
-    hooks:
-      - id: check-manifest
+        args: [ '--config-file=.yamllint.yaml' ]
   - repo: https://github.com/python-jsonschema/check-jsonschema
     rev: 0.23.0
     hooks:
@@ -91,5 +86,5 @@ ci:
   autoupdate_branch: ''
   autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
   autoupdate_schedule: weekly
-  skip: [ check-manifest ]
+  skip: [ ]
   submodules: false

.readthedocs.yml

@@ -17,18 +17,20 @@ build:
   tools:
     python: "mambaforge-4.10"
   jobs:
+    post_install:
+      - pip install .[docs,gis]
     pre_build:
       - sphinx-apidoc -o docs/apidoc --private --module-first ravenpy
-      - sphinx-build -b linkcheck docs/ _build/linkcheck
+      - sphinx-build -b linkcheck docs/ _build/linkcheck || true
 
 formats: all
 
 conda:
   environment: environment-rtd.yml
 
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - dev
+#python:
+#  install:
+#    - method: pip
+#      path: .
+#      extra_requirements:
+#        - dev

CONTRIBUTING.rst

@@ -75,7 +75,7 @@ Ready to contribute? Here's how to set up `ravenpy` for local development.
     $ pre-commit install
 
    Special style and formatting checks will be run when you commit your changes. You
-   can always run the hooks on their own with:
+   can always run the hooks on their own with::
 
     $ pre-commit run -a
 
@@ -119,7 +119,7 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 3.8, 3.9, and 3.10. Check
+3. The pull request should work for Python 3.8, 3.9, 3.10, and 3.11. Check
    https://github.com/CSHS-CWRA/RavenPy/actions/workflows/main.yml
    and make sure that the tests pass for all supported Python versions.
 
@@ -128,7 +128,7 @@ Tips
 
 To run a subset of tests::
 
-$ pytest tests.test_ravenpy
+    $ pytest tests.test_ravenpy
 
 
 Versioning/Tagging
@@ -138,31 +138,43 @@ A reminder for the maintainers on how to deploy.
 Make sure all your changes are committed (including an entry in HISTORY.rst).
 Then run::
 
-$ bumpversion patch # possible: major / minor / patch
-$ git push
-$ git push --tags
+    $ bumpversion patch # possible: major / minor / patch
+    $ git push
+    $ git push --tags
 
 Packaging
 ---------
 
 When a new version has been minted (features have been successfully integrated test coverage and stability is adequate),
 maintainers should update the pip-installable package (wheel and source release) on PyPI as well as the binary on conda-forge.
 
-The simple approach
+The Automated Approach
+~~~~~~~~~~~~~~~~~~~~~~
+
+The simplest way to package `ravenpy` is to "publish" a version on GitHuh. GitHub CI Actions are presently configured to build the library and publish the packages on PyPI automatically.
+
+Tagged versions will trigger a GitHub Workflow (`tag-testpypi.yml`) that will attempt to build and publish the release on `TestPyPI <https://test.pypi.org>`_.
+
+.. note::
+    Should this step fail, changes may be needed in the package; Be sure to remove this tag on GitHub and locally, address any existing problems, and recreate the tag.
+
+To upload a new version to `PyPI <https://pypi.org/>`_, simply create a new "Published" release version on GitHub to trigger the upload workflow (`publish-pypi.yml`). When publishing on GitHub, the maintainer can either set the release notes manually (based on the `HISTORY.rst`), or set GitHub to generate release notes automatically. The choice of method is up to the maintainer.
+
+.. warning::
+    A published version on TestPyPI/PyPI can never be overwritten. Be sure to verify that the package published at https://test.pypi.org/project/ravenpy/ matches expectations before publishing a release version on GitHub.
+
+The Manual Approach
 ~~~~~~~~~~~~~~~~~~~
 
-The simplest approach to packaging for general support (pip wheels) requires the following packages installed:
- * setuptools
- * wheel
- * twine
+The manual approach to library packaging for general support (pip wheels) requires that the `flit <https://flit.pypa.io/en/stable/index.html>`_ library is installed.
 
 From the command line on your Linux distribution, simply run the following from the clone's main dev branch::
 
     # To build the packages (sources and wheel)
-    $ python setup.py sdist bdist_wheel
+    $ flit build
 
     # To upload to PyPI
-    $ twine upload dist/*
+    $ flit publish
 
 The new version based off of the version checked out will now be available via `pip` (`$ pip install ravenpy`).
 
@@ -177,8 +189,23 @@ In order to prepare an initial release on conda-forge, we *strongly* suggest con
  * https://github.com/conda-forge/staged-recipes
 
 Before updating the main conda-forge recipe, we echo the conda-forge documentation and *strongly* suggest performing the following checks:
- * Ensure that dependencies and dependency versions correspond with those of the tagged version, with open or pinned versions for the `host` requirements.
- * If possible, configure tests within the conda-forge build CI (e.g. `imports: ravenpy`, `commands: pytest ravenpy`)
+ * Ensure that dependencies and dependency versions correspond with those of the PyPI published version, with open or pinned versions for the `host` requirements.
+ * If possible, configure tests within the conda-forge build CI, e.g.:
+
+.. code-block:: yaml
+
+  test:
+    source_files:
+      - tests
+    requires:
+      - pip
+      - pytest
+      - pytest-xdist
+    imports:
+      - ravenpy
+    commands:
+      - pip check
+      - pytest
 
 Subsequent releases
 ^^^^^^^^^^^^^^^^^^^

HISTORY.rst

@@ -2,6 +2,16 @@
 History
 =======
 
+0.12.0 (2023-05-25)
+-------------------
+
+* Ravenpy now employs a new method for installing the Raven model using the `raven-hydro <https://github.com/Ouranosinc/raven-hydro>`_ python package  (based on `scikit-build-core`).
+* Replaced `setup.py`, `requirements.txt`, and `Manifest.in` for `PEP 517 <https://peps.python.org/pep-0517>`_ compliance (`pyproject.toml`) using the flit backend.
+* Dealt with an import-based error that occurred due to the sequence in which modules are loaded at import (attempting to call ravenpy before it is installed).
+* Updated pre-commit hooks to include formatters and checkers for TOML files.
+* The build recipes no longer build on each other, so when installing the dev or docs recipe, you must also install the gis recipe.
+* Updated the GeoServer API calls to work with the GeoPandas v0.13.0.
+
 0.11.0 (2023-02-16)
 -------------------