Updates from the package template (#159)

* Automatic package template update

* Update conf.py

* Update .pre-commit-config.yaml

* Update .pre-commit-config.yaml

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: nabobalis <[email protected]>
Co-authored-by: Stuart Mumford <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Nabil Freij <[email protected]>

Author: 4 people

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sunpy/package-template",
-  "commit": "e4da826808cc9caf3606609c80a98ed441b9da44",
+  "commit": "dd830771f0bb01d5313912e0082f3434715e474a",
   "checkout": null,
   "context": {
     "cookiecutter": {

.pre-commit-config.yaml

@@ -1,38 +1,35 @@
-exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
 repos:
-  - repo: https://github.com/PyCQA/docformatter
-    rev: v1.7.5
-    hooks:
-      - id: docformatter
-        args: [--in-place, --pre-summary-newline, --make-summary-multi]
-  - repo: https://github.com/PyCQA/autoflake
-    rev: v2.3.1
-    hooks:
-      - id: autoflake
-        args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
-        exclude: ".*(.fits|.fts|.fit|.txt|tca.*|extern.*|.rst|.md|docs/conf.py)$"
+    # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.6.8"
+    rev: "v0.6.9"
     hooks:
       - id: ruff
         args: ["--fix"]
-      - id: ruff-format
-  -   repo: https://github.com/pre-commit/pre-commit-hooks
-      rev: v4.6.0
-      hooks:
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|extern.*|{{ cookiecutter.module_name }}/extern)$"
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
       - id: check-ast
       - id: check-case-conflict
       - id: trailing-whitespace
-      - id: mixed-line-ending
-      - id: end-of-file-fixer
+        exclude: ".*(.fits|.fts|.fit|.header|.txt)$"
       - id: check-yaml
       - id: debug-statements
+      - id: check-added-large-files
+        args: ["--enforce-all", "--maxkb=1054"]
+      - id: end-of-file-fixer
+        exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*|.json)$|^CITATION.rst$"
+      - id: mixed-line-ending
+        exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*)$"
   - repo: https://github.com/codespell-project/codespell
     rev: v2.3.0
     hooks:
       - id: codespell
-        additional_dependencies:
-          - tomli
+        args: [ "--write-changes" ]
 ci:
   autofix_prs: false
   autoupdate_schedule: "quarterly"

docs/conf.py

@@ -24,7 +24,7 @@
 elif _version.is_devrelease:
     version = release = f"{_version.base_version}.dev{_version.dev}"
 is_development = _version.is_devrelease
-is_release = not (_version.is_prerelease or _version.is_devrelease)
+is_release = not(_version.is_prerelease or _version.is_devrelease)
 
 project = "sunpy-soar"
 copyright = f"{datetime.datetime.now().year}, The SunPy Community"  # NOQA: A001, DTZ005
@@ -51,10 +51,12 @@
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 source_suffix = ".rst"
 master_doc = "index"
-default_role = "obj"
 napoleon_use_rtype = False
 napoleon_google_docstring = False
 
+# Treat everything in single ` as a Python reference.
+default_role = "py:obj"
+
 # -- Options for intersphinx extension ---------------------------------------
 intersphinx_mapping = {
     "python": (

sunpy_soar/attrs.py

@@ -7,7 +7,8 @@
 import astropy.units as u
 import sunpy.net.attrs as a
 from astropy.units import quantity_input
-from sunpy.net.attr import AttrAnd, AttrOr, AttrWalker, DataAttr, Range, SimpleAttr
+from sunpy.net.attr import (AttrAnd, AttrOr, AttrWalker, DataAttr, Range,
+                            SimpleAttr)
 from sunpy.util.exceptions import SunpyUserWarning
 
 __all__ = ["Product", "SOOP", "Distance"]