Merge pull request #416 from raybellwaves/use-pyproject

Use pyproject

Author: raybellwaves

.github/workflows/python-publish.yml

@@ -3,7 +3,7 @@ name: Upload Python Package
 on:
   push:
     tags:
-      - 'v*' # Push events to matching v*, i.e. v0.0.x,
+      - "v*" # Push events to matching v*, i.e. v0.0.x,
 
 jobs:
   release:
@@ -28,19 +28,19 @@ jobs:
     needs: release
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Python
-      uses: actions/setup-python@v1
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build and publish
+        run: python -m build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.pep8speaks.yml

@@ -2,84 +2,83 @@ default_language_version:
   python: python3
 
 ci:
-    autofix_commit_msg: |
-        [pre-commit.ci] auto fixes from pre-commit.com hooks
+  autofix_commit_msg: |
+    [pre-commit.ci] auto fixes from pre-commit.com hooks
 
-        for more information, see https://pre-commit.ci
-    autofix_prs: true
-    autoupdate_branch: ''
-    autoupdate_commit_msg: '[pre-commit.ci] pre-commit autoupdate'
-    autoupdate_schedule: quarterly
-    skip: []
-    submodules: false
+    for more information, see https://pre-commit.ci
+  autofix_prs: true
+  autoupdate_branch: ""
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: quarterly
+  skip: []
+  submodules: false
 
 repos:
-  -   repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v4.4.0
-      hooks:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
       - id: check-added-large-files
       - id: check-docstring-first
       - id: check-json
-        exclude: 'asv.conf.json'
+        exclude: "asv.conf.json"
       - id: check-merge-conflict
       - id: check-toml
       - id: check-yaml
-        args: [ '--allow-multiple-documents' ]
+        args: ["--allow-multiple-documents"]
       - id: debug-statements
       - id: end-of-file-fixer
       - id: no-commit-to-branch
       - id: pretty-format-json
-        args: [ '--autofix', '--no-ensure-ascii', '--no-sort-keys' ]
-        exclude: '.ipynb|asv.conf.json'
+        args: ["--autofix", "--no-ensure-ascii", "--no-sort-keys"]
+        exclude: ".ipynb|asv.conf.json"
       - id: trailing-whitespace
 
-  -   repo: https://github.com/psf/black-pre-commit-mirror
-      rev: 23.10.1
-      hooks:
-      - id: black
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.1.14"
+    hooks:
+      - id: ruff
+        args: ["--select", "E,F,I001"]
+        types_or: [python, pyi, jupyter]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]
 
-  -   repo: https://github.com/PyCQA/flake8
-      rev: 6.1.0
-      hooks:
-      - id: flake8
-
-  -   repo: https://github.com/PyCQA/isort
-      rev: 5.12.0
-      hooks:
-      - id: isort
-
-  -   repo: https://github.com/keewis/blackdoc
-      rev: v0.3.8
-      hooks:
+  - repo: https://github.com/keewis/blackdoc
+    rev: v0.3.8
+    hooks:
       - id: blackdoc
-        additional_dependencies: [ 'black==23.10.1' ]
+        additional_dependencies: ["black==23.10.1"]
 
-  -   repo: https://github.com/PyCQA/doc8
-      rev: v1.0.0
-      hooks:
+  - repo: https://github.com/PyCQA/doc8
+    rev: v1.0.0
+    hooks:
       - id: doc8
-        args: ["--max-line-length", "100",
-               "--allow-long-titles",
-               "--ignore-path", "docs/source/api/"]
+        args:
+          [
+            "--max-line-length",
+            "100",
+            "--allow-long-titles",
+            "--ignore-path",
+            "docs/source/api/",
+          ]
 
-  -   repo: https://github.com/pre-commit/mirrors-mypy
-      rev: v0.982
-      hooks:
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: "v1.8.0"
+    hooks:
       - id: mypy
-        exclude: 'asv_bench'
+        exclude: "asv_bench"
         additional_dependencies: [
             # Type stubs
             types-python-dateutil,
             types-pkg_resources,
             types-PyYAML,
             types-pytz,
-            typing-extensions==3.10.0.0,
+            typing-extensions,
             # Dependencies that are typed
             numpy,
           ]
 
-  -   repo: https://github.com/python-jsonschema/check-jsonschema
-      rev: 0.27.0
-      hooks:
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.27.0
+    hooks:
       - id: check-github-workflows
       - id: check-readthedocs

.pre-commit-config.yaml

@@ -125,7 +125,7 @@ Preparing Pull Requests
 
 #. Install dependencies into a new conda environment::
 
-    $ conda env update -f ci/dev.yml
+    $ mamba env update -f ci/dev.yml
     $ conda activate xskillscore-dev
 
 #. Make an editable install of xskillscore by running::
@@ -154,6 +154,12 @@ Preparing Pull Requests
 
     $ pytest --doctest-modules xskillscore --ignore xskillscore/tests
 
+   You can also test notebooks by doing::
+
+    $ cd docs
+    $ nbstripout source/*.ipynb
+    $ make -j4 html
+
   Please stick to `xarray <http://xarray.pydata.org/en/stable/contributing.html>`_'s testing recommendations.
 
 #. Running the performance test suite

HOWTOCONTRIBUTE.rst

@@ -8,6 +8,8 @@ Release Procedure
  * Update ``CHANGELOG.rst``
  * Make sure all new changes, features are reflected in the documentation.
 
+ * Update ``pyproject.toml`` and `version` in `xskillscore/__init__`
+
 #. Open a new pull request for this branch targeting `main`
 
 #. After all tests pass and the PR has been approved, merge the PR into ``main``

HOWTORELEASE.rst

@@ -1,10 +1,6 @@
 # Write the benchmarking functions here.
 # See "Writing benchmarks" in the asv docs for more information.
 
-import os
-
-import numpy as np
-import xarray as xr
 
 from xskillscore import mae, mse, pearson_r, pearson_r_p_value, rmse
 

asv_bench/benchmarks/deterministic.py

@@ -2,8 +2,6 @@
 # See "Writing benchmarks" in the asv docs for more information.
 
 
-import numpy as np
-import xarray as xr
 from scipy.stats import norm
 
 from xskillscore import (

asv_bench/benchmarks/probabilistic.py

@@ -2,19 +2,23 @@
 # See "Writing benchmarks" in the asv docs for more information.
 
 
-import os
-import shutil
-
 import bottleneck as bn
 import numpy as np
-import pandas as pd
 import xarray as xr
 
 from xskillscore import (
     mae as xs_mae,
+)
+from xskillscore import (
     mse as xs_mse,
+)
+from xskillscore import (
     pearson_r as xs_pearson_r,
+)
+from xskillscore import (
     rmse as xs_rmse,
+)
+from xskillscore import (
     spearman_r as xs_spearman_r,
 )
 

asv_bench/benchmarks/xr_vs_xs.py

@@ -4,36 +4,36 @@ channels:
 dependencies:
   - python >= 3.9,<3.12
   # Documentation
+  - matplotlib-base
   - nbsphinx
   - nbstripout
   - sphinx
   - sphinx_rtd_theme
   - sphinx-autosummary-accessors
-  - matplotlib-base
+  - sphinxcontrib-napoleon
   # IDE
   - jupyterlab
   # Numerics
   - bottleneck
-  - statsmodels
   - cftime
   - dask-core
   - numba>=0.52
   - numpy
   - properscoring
   - scikit-learn
   - scipy
+  - statsmodels
   - xarray>=0.16.1
   - xhistogram>=0.3.0
   # Package Management
   - asv
-  - black
+  - build
   - coveralls
   - doc8
-  - isort
-  - flake8
   - pre-commit
   - pytest
   - pytest-cov
-  - pytest-lazy-fixture
+  - pytest-xdist
   - pytest-sugar
   - mypy
+  - ruff

ci/dev.yml

@@ -4,24 +4,24 @@ channels:
 dependencies:
   - python >=3.9
   - bottleneck
+  - cftime
+  - dask-core
   - doc8
   - ipykernel
   - ipython
+  - matplotlib-base
   - nbsphinx
   - numpy
   - pip
   - properscoring
-  - statsmodels
-  - matplotlib-base
+  - scikit-learn
   - scipy
   - sphinx!=4.4.0
   - sphinx_rtd_theme
   - sphinx-autosummary-accessors
   - sphinx-copybutton
+  - statsmodels
   - xarray>=0.16.1
   - xhistogram>=0.3.0
-  - scikit-learn
-  - cftime
-  - dask-core
   - pip:
       - -e ..