Updates from the package template

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sunpy/package-template",
-  "commit": "9fff6e66fecd5ab2ed7fefbc0687791e83f46a8a",
+  "commit": "de26b5a88dcad688046a5a5edbe00b5af1793e13",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -26,6 +26,7 @@
       "use_extended_ruff_linting": "y",
       "matrix_room_id": "!RehafayCrAiXbzVpXI:openastronomy.org",
       "extra_ci_jobs": "mypy,allowed-fail-tests",
+      "use_sunpy_pr_template": "n",
       "_sphinx_theme": "sunpy",
       "_parent_project": "",
       "_install_requires": "",
@@ -35,7 +36,7 @@
         ".github/workflows/zizmor.yml"
       ],
       "_template": "https://github.com/sunpy/package-template",
-      "_commit": "9fff6e66fecd5ab2ed7fefbc0687791e83f46a8a"
+      "_commit": "de26b5a88dcad688046a5a5edbe00b5af1793e13"
     }
   },
   "directory": null

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ permissions: {}
 
 jobs:
   core:
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@22ddf09dfabb443adddfb9f861b7d41a787d6b1a  # v3.0.3
     permissions:
       id-token: write
     with:
@@ -58,7 +58,7 @@ jobs:
 
   test:
     needs: [core, sdist_verify]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@22ddf09dfabb443adddfb9f861b7d41a787d6b1a  # v3.0.3
     permissions:
       id-token: write
     with:
@@ -75,7 +75,7 @@ jobs:
 
   docs:
     needs: [core]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@22ddf09dfabb443adddfb9f861b7d41a787d6b1a  # v3.0.3
     with:
       default_python: '3.13'
       submodules: false
@@ -89,7 +89,7 @@ jobs:
 
   mypy:
     needs: [core]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@22ddf09dfabb443adddfb9f861b7d41a787d6b1a  # v3.0.3
     with:
       submodules: false
       toxdeps: tox-pypi-filter
@@ -98,7 +98,7 @@ jobs:
 
   allowed-fail-tests:
     needs: [core]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@22ddf09dfabb443adddfb9f861b7d41a787d6b1a  # v3.0.3
     permissions:
       id-token: write
     with:
@@ -119,7 +119,7 @@ jobs:
         contains(github.event.pull_request.labels.*.name, 'Run publish')
       )
     needs: [test]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@8c8bb6c6c962542921f993d47d26df38dccd50b1  # v3.0.2
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@22ddf09dfabb443adddfb9f861b7d41a787d6b1a  # v3.0.3
     with:
       python-version: '3.13'
       test_extras: 'tests'

.github/workflows/sub_package_update.yml

@@ -114,7 +114,7 @@ jobs:
             **To run the CI on this pull request you will need to close it and reopen it.**
 
   report-fail:
-    if: failure()
+    if: ${{ failure() && github.event_name == 'schedule' }}
     needs: [update]
     runs-on: ubuntu-latest
     permissions:

.pre-commit-config.yaml

@@ -1,19 +1,13 @@
 repos:
     # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.16.1"
+    rev: "v0.16.5"
     hooks:
       - id: ruff-check
         args: ["--fix"]
         types: [python]
         # Define here once and then reference using YAML anchor
         exclude: &exclude_dirs ^dkist/(data|extern)/
-  - repo: https://github.com/PyCQA/isort
-    rev: 8.0.1
-    hooks:
-      - id: isort
-        types: [python]
-        exclude: *exclude_dirs
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0
     hooks:
@@ -47,6 +41,12 @@ repos:
         args: [ "--write-changes", "-D", "-", "-D", ".codespell-dict.txt"]
         types_or: [python, rst]
         exclude: *exclude_dirs
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v1.0.2
+    hooks:
+      - id: sphinx-lint
+        types_or: [python, rst]
+        exclude: *exclude_dirs
 ci:
   autofix_prs: false
   autoupdate_schedule: "quarterly"

.ruff.toml

@@ -15,6 +15,7 @@ select = [
   "W",
   "UP",
   "PT",
+  "I",
   "BLE",
   # "A",
   "C4",
@@ -76,6 +77,7 @@ extend-ignore = [
   "A001",
   "BLE001",
   "T201",
+  "I", # isort
 ]
 "docs/*.py" = [
   "INP001", # File is part of an implicit namespace package.
@@ -89,6 +91,7 @@ extend-ignore = [
   "F401", # Unused import
   "F403", # from {name} import * used; unable to detect undefined names
   "F405", # {name} may be undefined, or defined from star imports
+  "I", # isort
 ]
 "test_*.py" = [
   "E402", # Module level import not at top of cell
@@ -123,3 +126,21 @@ extend-ignore = [
 
 [lint.pydocstyle]
 convention = "numpy"
+
+[lint.isort]
+default-section = "third-party"
+section-order = [
+  "future",
+  "standard-library",
+  "third-party",
+  "astropy",
+  "sunpy",
+  "first-party",
+  "local-folder",
+]
+known-first-party = ["dkist"]
+no-lines-before = ["local-folder"]
+
+[lint.isort.sections]
+"astropy" = ["astropy", "asdf", "gwcs", "reproject"]
+"sunpy" = ["sunpy"]

dkist/dataset/dataset.py

@@ -1,16 +1,14 @@
 from textwrap import dedent
 
 import numpy as np
+from ndcube.ndcube import NDCube, NDCubeLinkedDescriptor
 
 import gwcs
 from astropy.wcs.wcsapi.wrappers import SlicedLowLevelWCS
 
-from ndcube.ndcube import NDCube, NDCubeLinkedDescriptor
-
 from dkist.io.dask.striped_array import FileManager
 from dkist.io.file_manager import DKISTFileManager
 from dkist.utils.decorators import deprecated
-
 from .utils import dataset_info_str
 
 __all__ = ["Dataset"]

dkist/dataset/inversion.py

@@ -1,12 +1,11 @@
-import types
 import textwrap
+import types
 from collections.abc import Iterable
 
 import matplotlib.figure
 import matplotlib.pyplot as plt
 import numpy as np
 from matplotlib.gridspec import GridSpec
-
 from ndcube import NDCollection
 
 from dkist.utils.exceptions import DKISTUserWarning

dkist/dataset/loader.py

@@ -1,8 +1,8 @@
 import re
 import warnings
-from pathlib import Path
-from functools import cache, singledispatch
 from collections import defaultdict
+from functools import cache, singledispatch
+from pathlib import Path
 
 from packaging.version import Version
 from parfive import Results

dkist/dataset/tests/test_inversion.py

@@ -1,5 +1,5 @@
 import collections.abc
-from itertools import product, permutations
+from itertools import permutations, product
 
 import matplotlib.pyplot as plt
 import numpy as np

dkist/dataset/tests/test_load_dataset.py

@@ -1,7 +1,7 @@
+import contextlib
+import numbers
 import re
 import shutil
-import numbers
-import contextlib
 
 import pytest
 from parfive import Results

dkist/dataset/tests/test_tiled_dataset.py

@@ -1,5 +1,5 @@
-import re
 import copy
+import re
 from importlib import resources
 
 import matplotlib.pyplot as plt

dkist/dataset/tiled_dataset.py

@@ -6,13 +6,13 @@
 not contiguous in the spatial dimensions (due to overlaps and offsets).
 """
 
-import os
 import copy
+import os
 import types
 import warnings
-from typing import Any, Self, Literal
+from collections.abc import Collection, Iterable
 from textwrap import dedent
-from collections.abc import Iterable, Collection
+from typing import Any, Literal, Self
 
 import matplotlib.figure
 import matplotlib.pyplot as plt
@@ -25,7 +25,6 @@
 
 from dkist.io.file_manager import DKISTFileManager
 from dkist.utils.exceptions import DKISTDeprecationWarning, DKISTUserWarning
-
 from .dataset import Dataset
 from .utils import dataset_info_str
 

dkist/io/asdf/converters/models.py

@@ -1,6 +1,7 @@
-import astropy.units as u
 from asdf_astropy.converters.transform.core import TransformConverterBase, parameter_to_value
 
+import astropy.units as u
+
 
 class VaryingCelestialConverter(TransformConverterBase):
     tags = [

dkist/io/asdf/entry_points.py

@@ -6,10 +6,17 @@
 from asdf.extension import ManifestExtension
 from asdf.resource import DirectoryResourceMapping
 
-from dkist.io.asdf.converters import (AsymmetricMappingConverter, CoupledCompoundConverter,
-                                      DatasetConverter, FileManagerConverter,
-                                      InversionConverter, ProfilesConverter, RavelConverter,
-                                      TiledDatasetConverter, VaryingCelestialConverter)
+from dkist.io.asdf.converters import (
+    AsymmetricMappingConverter,
+    CoupledCompoundConverter,
+    DatasetConverter,
+    FileManagerConverter,
+    InversionConverter,
+    ProfilesConverter,
+    RavelConverter,
+    TiledDatasetConverter,
+    VaryingCelestialConverter,
+)
 
 
 def get_resource_mappings():

dkist/io/asdf/tests/test_models.py

@@ -6,10 +6,16 @@
 from astropy.coordinates.matrix_utilities import rotation_matrix
 from astropy.modeling import CompoundModel
 
-from dkist.wcs.models import (CoupledCompoundModel, InverseVaryingCelestialTransform,
-                              InverseVaryingCelestialTransform2D, Ravel, Unravel,
-                              VaryingCelestialTransform, VaryingCelestialTransform2D,
-                              varying_celestial_transform_from_tables)
+from dkist.wcs.models import (
+    CoupledCompoundModel,
+    InverseVaryingCelestialTransform,
+    InverseVaryingCelestialTransform2D,
+    Ravel,
+    Unravel,
+    VaryingCelestialTransform,
+    VaryingCelestialTransform2D,
+    varying_celestial_transform_from_tables,
+)
 
 
 def test_roundtrip_vct():

dkist/io/asdf/tests/test_schema_infra.py

@@ -1,5 +1,5 @@
-import pathlib
 import itertools
+import pathlib
 
 import pytest
 

dkist/io/dask/striped_array.py

@@ -12,12 +12,12 @@
 view into the original ``StripedExternalArray`` object through the
 ``StripedExternalArrayView`` class.
 """
-import os
 import abc
-from typing import Any, Protocol
+import os
+from collections.abc import Iterable
 from pathlib import Path
 from textwrap import dedent
-from collections.abc import Iterable
+from typing import Any, Protocol
 
 import dask.array
 import numpy as np

dkist/io/file_manager.py

@@ -2,12 +2,12 @@
 This file contains the DKIST specific FileManager code.
 """
 
-import os
 import json
+import os
 import urllib
-from typing import Any
 from pathlib import Path
 from textwrap import dedent
+from typing import Any
 
 from parfive import Downloader, Results
 

dkist/logger.py

@@ -11,9 +11,9 @@
   - Overrides warnings.showwarnings so that subclasses of given warning classes are displayed using the logger.
 * Sets up a ``log`` instance which uses the Astropy StreamHandler class to log to stdout and colourise the output.
 """
+import logging
 import os
 import sys
-import logging
 import warnings
 
 from astropy.logger import StreamHandler as AstropyStreamHandler

dkist/net/attrs_values.py

@@ -1,8 +1,8 @@
 "Functions for working with the net submodule"
-import json
-import urllib
 import datetime as dt
 import importlib.resources
+import json
+import urllib
 from pathlib import Path
 
 import platformdirs