tidy up for release (#86)

Author: Nabil Freij

.circleci/config.yml

@@ -32,7 +32,7 @@ jobs:
       jobname:
         type: string
     docker:
-      - image: circleci/python:3.8
+      - image: cimg/python:3.9
     environment:
       TOXENV=<< parameters.jobname >>
     steps:
@@ -55,7 +55,7 @@ jobs:
       jobname:
         type: string
     docker:
-      - image: circleci/python:3.8
+      - image: cimg/python:3.9
     environment:
       TOXENV: << parameters.jobname >>
       GIT_SSH_COMMAND: ssh -i ~/.ssh/id_rsa_6464b6a8248237ca368fd4690777d921

.pre-commit-config.yaml

@@ -1,33 +1,38 @@
-ci:
-  autofix_prs: false
 repos:
--   repo: https://github.com/psf/black
-    rev: 22.3.0
+  - repo: https://github.com/myint/docformatter
+    rev: v1.4
     hooks:
-    - id: black
--   repo: https://github.com/myint/autoflake
+      - id: docformatter
+        args: [--in-place, --pre-summary-newline, --make-summary-multi]
+  - repo: https://github.com/myint/autoflake
     rev: v1.4
     hooks:
       - id: autoflake
         args: ['--in-place', '--remove-all-unused-imports', '--remove-unused-variable']
         exclude: ".*(.fits|.fts|.fit|.txt|tca.*|extern.*|.rst|.md|__init__.py|docs/conf.py)$"
--   repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
-    hooks:
+  -   repo: https://github.com/psf/black
+      rev: 22.3.0
+      hooks:
+      - id: black
+        exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
+  -   repo: https://github.com/PyCQA/isort
+      rev: 5.10.1
+      hooks:
       - id: isort
-        args: ['--sp','setup.cfg']
-        exclude: ".*(.fits|.fts|.fit|.txt|tca.*|extern.*|.rst|.md|docs/conf.py)$"
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.2.0
-    hooks:
+        exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
+  -   repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v4.2.0
+      hooks:
       - id: check-ast
       - id: check-case-conflict
       - id: trailing-whitespace
-        exclude: ".*(.fits|.fts|.fit|.txt)$"
+        exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
+      - id: mixed-line-ending
+        exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
+      - id: end-of-file-fixer
+        exclude: ".*(.fits|.fts|.fit|.txt|.csv)$"
       - id: check-yaml
       - id: debug-statements
-      - id: check-added-large-files
-      - id: end-of-file-fixer
-        exclude: ".*(.fits|.fts|.fit|.txt|tca.*)$"
-      - id: mixed-line-ending
-        exclude: ".*(.fits|.fts|.fit|.txt|tca.*)$"
+
+ci:
+  autofix_prs: false

CHANGELOG.rst

@@ -1,3 +1,11 @@
+0.4.2 (2022-05-24)
+==================
+
+Breaking Changes
+----------------
+
+- Minimum version of ``sunpy`` required is now 4.0.0
+
 0.4.1 (2022-04-05)
 ==================
 

azure-pipelines.yml

@@ -58,15 +58,13 @@ stages:
           apt:
             - graphviz
         envs:
-          - macos: py37
-          - windows: py38
+          - macos: py38
+          - windows: py39
           - linux: build_docs
             posargs: " "
             pytest: false
           - linux: py39-online
-          - linux: py37-oldestdeps
-          - linux: py39-conda
-            libraries: {}
+          - linux: py38-oldestdeps
 
   - ${{ if or(eq(variables['Build.Reason'], 'Schedule'), eq(variables['Build.Reason'], 'Manual')) }}:
     - stage: CronTests
@@ -81,6 +79,8 @@ stages:
           toxdeps: tox-pypi-filter
           envs:
             - linux: py310-devdeps
+            - linux: py39-conda
+              libraries: {}
 
   # On branches which aren't main, and not Pull Requests, build the wheels but only upload them on tags
   - ${{ if and(ne(variables['Build.Reason'], 'PullRequest'), or(ne(variables['Build.SourceBranchName'], 'main'), eq(variables['Build.Reason'], 'Schedule'), eq(variables['Build.Reason'], 'Manual'))) }}:

docs/conf.py

@@ -1,5 +1,6 @@
 """
 Configuration file for the Sphinx documentation builder.
+
 isort:skip_file
 """
 # flake8: NOQA: E402

examples/tracing_loops.py

@@ -45,9 +45,7 @@
 # The base flux and median flux ratio ``qthresh1`` is 0.0.
 # The noise threshold in the image with repect to median flux ``qthresh2`` is 3.0 .
 # For the meaning of these parameters please consult the OCCULT2 article.
-loops = trace.occult2(
-    trace_map.data, nsm1=3, rmin=30, lmin=25, nstruc=1000, ngap=0, qthresh1=0.0, qthresh2=3.0
-)
+loops = trace.occult2(trace_map.data, nsm1=3, rmin=30, lmin=25, nstruc=1000, ngap=0, qthresh1=0.0, qthresh2=3.0)
 
 ###############################################################################
 # `~sunkit_image.trace.occult2` returns a list, each element of which is a detected loop.

pyproject.toml

@@ -2,14 +2,14 @@
 requires = [
   "extension-helpers",
   "oldest-supported-numpy",
-  "setuptools_scm",
-  "setuptools",
+  "setuptools>=56,!=61.0.0",
+  "setuptools_scm[toml]>=6.2",
   "wheel",
 ]
 build-backend = 'setuptools.build_meta'
 
 [tool.black]
-line-length = 110
+line-length = 120
 include = '\.pyi?$'
 exclude = '''
 (

setup.cfg

@@ -19,20 +19,20 @@ classifiers =
   Operating System :: OS Independent
   Programming Language :: Python
   Programming Language :: Python :: 3
-  Programming Language :: Python :: 3.7
   Programming Language :: Python :: 3.8
   Programming Language :: Python :: 3.9
+  Programming Language :: Python :: 3.10
   Topic :: Scientific/Engineering :: Physics
 
 [options]
-python_requires = >=3.7
+python_requires = >=3.8
 packages = find:
 include_package_data = True
 setup_requires =
   setuptools_scm
 install_requires =
   scikit-image>=0.18.0
-  sunpy>=3.0.0
+  sunpy>=4.0.0
 
 [options.extras_require]
 tests =

sunkit_image/__init__.py

@@ -23,8 +23,6 @@ class UnsupportedPythonError(Exception):
 
 if sys.version_info < tuple(int(val) for val in __minimum_python_version__.split(".")):
     # This has to be .format to keep backwards compatibly.
-    raise UnsupportedPythonError(
-        "sunkit_image does not support Python < {}".format(__minimum_python_version__)
-    )
+    raise UnsupportedPythonError("sunkit_image does not support Python < {}".format(__minimum_python_version__))
 
 __all__ = []

sunkit_image/_dev/__init__.py

@@ -1,6 +1,7 @@
 """
-This package contains utilities that are only used when developing sunkit_image in a
-copy of the source repository.
+This package contains utilities that are only used when developing sunkit_image
+in a copy of the source repository.
+
 These files are not installed, and should not be assumed to exist at
 runtime.
 """