Merge pull request #210 from VeckoTheGecko/changes2

Ruff config, pytest config, pre-commit config

.circleci/config.yml

@@ -25,7 +25,6 @@ jobs:
       - store_artifacts:
           path: docs/_build/html/
 
-
 workflows:
   main:
     jobs:

.git-blame-ignore-revs

@@ -0,0 +1 @@
+6651931839dd826ea9a171688ec2595976a84871

.github/workflows/doc-artifacts.yml

@@ -9,4 +9,4 @@ jobs:
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           artifact-path: 0/docs/_build/html/index.html
-          circleci-jobs: build_docs
+          circleci-jobs: build_docs

.github/workflows/publish-to-pypi.yml

@@ -8,106 +8,106 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: "3.x"
-    - name: Install pypa/build
-      run: python3 -m pip install build --user
-    - name: Build a binary wheel and a source tarball
-      run: python3 -m build
-    - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Install pypa/build
+        run: python3 -m pip install build --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
 
   publish-to-pypi:
     name: >-
       Publish Python 🐍 distribution 📦 to PyPI
-    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
     needs:
-    - build
+      - build
     runs-on: ubuntu-latest
     environment:
       name: pypi
       url: https://pypi.org/p/pyglider
     permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
+      id-token: write # IMPORTANT: mandatory for trusted publishing
 
     steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
 
   github-release:
     name: >-
       Sign the Python 🐍 distribution 📦 with Sigstore
       and upload them to GitHub Release
     needs:
-    - publish-to-pypi
+      - publish-to-pypi
     runs-on: ubuntu-latest
 
     permissions:
-      contents: write  # IMPORTANT: mandatory for making GitHub Releases
-      id-token: write  # IMPORTANT: mandatory for sigstore
+      contents: write # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write # IMPORTANT: mandatory for sigstore
 
     steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Sign the dists with Sigstore
-      uses: sigstore/[email protected]
-      with:
-        inputs: >-
-          ./dist/*.tar.gz
-          ./dist/*.whl
-    - name: Create GitHub Release
-      env:
-        GITHUB_TOKEN: ${{ github.token }}
-      run: >-
-        gh release create
-        '${{ github.ref_name }}'
-        --repo '${{ github.repository }}'
-        --notes ""
-    - name: Upload artifact signatures to GitHub Release
-      env:
-        GITHUB_TOKEN: ${{ github.token }}
-      # Upload to GitHub Release using the `gh` CLI.
-      # `dist/` contains the built packages, and the
-      # sigstore-produced signatures and certificates.
-      run: >-
-        gh release upload
-        '${{ github.ref_name }}' dist/**
-        --repo '${{ github.repository }}'
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Sign the dists with Sigstore
+        uses: sigstore/[email protected]
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          '${{ github.ref_name }}'
+          --repo '${{ github.repository }}'
+          --notes ""
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages, and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload
+          '${{ github.ref_name }}' dist/**
+          --repo '${{ github.repository }}'
 
   publish-to-testpypi:
     name: Publish Python 🐍 distribution 📦 to TestPyPI
     needs:
-    - build
+      - build
     runs-on: ubuntu-latest
 
     environment:
       name: testpypi
       url: https://test.pypi.org/p/pyglider
 
     permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
+      id-token: write # IMPORTANT: mandatory for trusted publishing
 
     steps:
-    - name: Download all the dists
-      uses: actions/download-artifact@v4
-      with:
-        name: python-package-distributions
-        path: dist/
-    - name: Publish distribution 📦 to TestPyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        repository-url: https://test.pypi.org/legacy/
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

.gitignore

@@ -5,4 +5,4 @@ docs/pyglider
 dist
 
 *.png
-.DS_Store
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+exclude: "^tests/example-data/.*"
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-ast
+      - id: check-json
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.2
+    hooks:
+      - id: ruff
+        name: ruff lint
+        args: [--fix, --show-fixes]
+      - id: ruff-format
+  - repo: https://github.com/rbubley/mirrors-prettier # Update mirror as official mirror is deprecated
+    rev: v3.4.2
+    hooks:
+      - id: prettier
+  - repo: https://github.com/ComPWA/taplo-pre-commit
+    rev: v0.9.3
+    hooks:
+      - id: taplo-format
+        args: ["--option", "array_auto_collapse=false"]
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.23
+    hooks:
+      - id: validate-pyproject
+        additional_dependencies: ["validate-pyproject-schema-store[all]"]

.readthedocs.yaml

@@ -28,7 +28,6 @@ python:
     # Install our python package before building the docs
     - method: pip
       path: .
-
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:
 #   - pdf
@@ -39,4 +38,4 @@ python:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 # python:
 #   install:
-#     - requirements: docs/requirements.txt
+#     - requirements: docs/requirements.txt

LICENSE

@@ -188,4 +188,4 @@ third-party archives.
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -1,11 +1,11 @@
 ![](docs/_static/PyGliderHorizontal.svg)
 
-Python tools for interacting with ocean glider data.   PyGlider takes data from
+Python tools for interacting with ocean glider data. PyGlider takes data from
 Teledyne/Webb Slocum gliders and Alseamar SeaExplorers and creates CF-compliant
 NetCDF files.
 
 For documentation, please see <http://pyglider.readthedocs.io>
 
 ### Contact
 
-Get in touch with us using Discussion above or by opening an issue.
+Get in touch with us using Discussion above or by opening an issue.

codecov.yml

@@ -20,10 +20,10 @@ coverage:
         if_no_uploads: error
         if_not_found: success
         if_ci_failed: failure
-        paths: '!tests/.*'
+        paths: "!tests/.*"
       tests:
         target: auto
         if_no_uploads: error
         if_not_found: success
         if_ci_failed: failure
-        paths: 'tests/.*'
+        paths: "tests/.*"

docs/Install.md

@@ -2,8 +2,8 @@
 
 ## conda/pip
 
-PyGlider depends on `dask` and `netcdf4`, both of which can be tricky to install using ``pip``,
-hence we recommend these be installed with [``conda``](https://www.anaconda.com/).  To install
+PyGlider depends on `dask` and `netcdf4`, both of which can be tricky to install using `pip`,
+hence we recommend these be installed with [`conda`](https://www.anaconda.com/). To install
 PyGlider, create an environment, and do
 
 ```
@@ -15,13 +15,13 @@ conda install -c conda-forge pyglider
 ## Editable installation
 
 If you want to be able to edit the files in `pyglider/pyglider` then install
-the dependencies as above.  Fork of PyGlider on github, and then clone it locally:
+the dependencies as above. Fork of PyGlider on github, and then clone it locally:
 
 ```
 git clone https://github.com/yourname/pyglider.git
 ```
 
-Navigate to the new ``pyglider`` directory and then do `pip install -e .`.
+Navigate to the new `pyglider` directory and then do `pip install -e .`.
 That will re-install pyglider with links to the local directory, so you
-can edit the library files. If you do so,  consider making a pull-request
+can edit the library files. If you do so, consider making a pull-request
 with your changes!