Registers package with sunpy template

.codecov.yaml

@@ -4,3 +4,8 @@ coverage:
     project:
       default:
         threshold: 0.2%
+
+codecov:
+  require_ci_to_pass: false
+  notify:
+    wait_for_ci: true

.codespellrc

@@ -0,0 +1,15 @@
+[codespell]
+skip = *.asdf,*.fits,*.fts,*.header,*.json,*.xsh,*cache*,*egg*,*extern*,.git,.idea,.tox,_build,*truncated,*.svg,.asv_env,.history
+ignore-words-list =
+    afile,
+    alog,
+    datas,
+    nd,
+    nin,
+    observ,
+    ot,
+    precess,
+    precessed,
+    sav,
+    te,
+    upto

.coveragerc

@@ -0,0 +1,30 @@
+[run]
+omit =
+  sunkit_instruments/conftest.py
+  sunkit_instruments/*setup_package*
+  sunkit_instruments/extern/*
+  sunkit_instruments/version*
+  */sunkit_instruments/conftest.py
+  */sunkit_instruments/*setup_package*
+  */sunkit_instruments/extern/*
+  */sunkit_instruments/version*
+
+[report]
+exclude_lines =
+  # Have to re-enable the standard pragma
+  pragma: no cover
+  # Don't complain about packages we have installed
+  except ImportError
+  # Don't complain if tests don't hit assertions
+  raise AssertionError
+  raise NotImplementedError
+  # Don't complain about script hooks
+  def main(.*):
+  # Ignore branches that don't pertain to this version of Python
+  pragma: py{ignore_python_version}
+  # Don't complain about IPython completion helper
+  def _ipython_key_completions_
+  # typing.TYPE_CHECKING is False at runtime
+  if TYPE_CHECKING:
+  # Ignore typing overloads
+  @overload

.cruft.json

@@ -0,0 +1,31 @@
+{
+  "template": "https://github.com/sunpy/package-template",
+  "commit": "f7458b35be5824d419efd6ce8c135ff67a00d1d5",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "package_name": "sunkit-instruments",
+      "module_name": "sunkit_instruments",
+      "short_description": "A SunPy-affiliated package for solar instrum",
+      "author_name": "The SunPy Community",
+      "author_email": "[email protected]",
+      "project_url": "https://sunpy.org",
+      "license": "BSD 3-Clause",
+      "minimum_python_version": "3.10",
+      "use_compiled_extensions": "n",
+      "enable_dynamic_dev_versions": "y",
+      "include_example_code": "n",
+      "include_cruft_update_github_workflow": "y",
+      "_sphinx_theme": "alabaster",
+      "_parent_project": "",
+      "_install_requires": "",
+      "_copy_without_render": [
+        "docs/_templates",
+        "docs/_static",
+        ".github/workflows/sub_package_update.yml"
+      ],
+      "_template": "https://github.com/sunpy/package-template"
+    }
+  },
+  "directory": null
+}

.flake8

@@ -0,0 +1,27 @@
+[flake8]
+ignore =
+    # missing-whitespace-around-operator
+    E225
+    # missing-whitespace-around-arithmetic-operator
+    E226
+    # line-too-long
+    E501
+    # unused-import
+    F401
+    # undefined-local-with-import-star
+    F403
+    # redefined-while-unused
+    F811
+    # Line break occurred before a binary operator
+    W503,
+    # Line break occurred after a binary operator
+    W504
+max-line-length = 110
+exclude =
+    .git
+    __pycache__
+    docs/conf.py
+    build
+    sunkit-instruments/__init__.py
+rst-directives =
+    plot

.github/workflows/ci.yml

@@ -29,22 +29,38 @@ jobs:
       posargs: -n auto
       envs: |
         - linux: py312
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  sdist_verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+      - run: python -m pip install -U --user build
+      - run: python -m build . --sdist
+      - run: python -m pip install -U --user twine
+      - run: python -m twine check dist/*
 
   test:
-    needs: [core]
+    needs: [core, sdist_verify]
     uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
     with:
       submodules: false
       coverage: codecov
       toxdeps: tox-pypi-filter
       posargs: -n auto
       envs: |
-        - macos: py311
-        - windows: py310
+        - windows: py311
+        - macos: py310
         - linux: py310-oldestdeps
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   docs:
-    needs: [test]
+    needs: [core]
     uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
     with:
       default_python: '3.12'
@@ -62,33 +78,49 @@ jobs:
     needs: [test]
     uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
     with:
+      default_python: '3.12'
+      submodules: false
+      coverage: codecov
+      toxdeps: tox-pypi-filter
+      posargs: -n auto --dist loadgroup
+      envs: |
+        - linux: py311-devdeps
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  cron:
+    if: |
+      github.event_name == 'workflow_dispatch' || (
+        github.event_name == 'pull_request' &&
+        contains(github.event.pull_request.labels.*.name, 'Run cron CI')
+      )
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
+    with:
+      default_python: '3.12'
       submodules: false
       coverage: codecov
       toxdeps: tox-pypi-filter
       posargs: -n auto --dist loadgroup
       envs: |
-        - linux: py312-online
-        - linux: py312-devdeps
+        - linux: py311-devdeps
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   publish:
-    # Build wheels when pushing to any branch except main
-    # publish.yml will only publish if tagged ^v.*
+    needs: [test, docs]
+    # Build wheels on PRs only when labelled. Releases will only be published if tagged ^v.*
+    # see https://github-actions-workflows.openastronomy.org/en/latest/publish.html#upload-to-pypi
     if: |
+      github.event_name != 'pull_request' ||
       (
-        github.event_name != 'pull_request' && (
-          github.ref_name != 'main' ||
-          github.event_name == 'workflow_dispatch'
-        )
-      ) || (
         github.event_name == 'pull_request' &&
         contains(github.event.pull_request.labels.*.name, 'Run publish')
       )
-    needs: [test]
     uses: OpenAstronomy/github-actions-workflows/.github/workflows/publish_pure_python.yml@main
     with:
-      python-version: "3.12"
-      test_extras: 'dev'
-      test_command: 'pytest -p no:warnings --doctest-rst -m "not mpl_image_compare" --pyargs sunkit_instruments'
+      python-version: '3.12'
+      test_extras: 'tests'
+      test_command: 'pytest -p no:warnings --doctest-rst --pyargs sunkit_instruments'
       submodules: false
     secrets:
       pypi_token: ${{ secrets.pypi_token }}

.github/workflows/sub_package_update.yml

@@ -0,0 +1,79 @@
+# This template is taken from the cruft example code, for further information please see:
+# https://cruft.github.io/cruft/#automating-updates-with-github-actions
+name: Automatic Update from package template
+permissions:
+    contents: write
+    pull-requests: write
+
+on:
+  # Allow manual runs through the web UI
+  workflow_dispatch:
+  schedule:
+    #        ┌───────── minute (0 - 59)
+    #        │ ┌───────── hour (0 - 23)
+    #        │ │ ┌───────── day of the month (1 - 31)
+    #        │ │ │ ┌───────── month (1 - 12 or JAN-DEC)
+    #        │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT)
+    - cron: '0 7 * * 1'  # Every Monday at 7am UTC
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - add-paths: .
+            body: apply the changes to this repo.
+            branch: cruft/update
+            commit-message: "Automatic package template update"
+            title: Updates from the package template
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install Cruft
+        run: python -m pip install git+https://github.com/Cadair/cruft@patch-p1
+
+      - name: Check if update is available
+        continue-on-error: false
+        id: check
+        run: |
+          CHANGES=0
+          if [ -f .cruft.json ]; then
+            if ! cruft check; then
+              CHANGES=1
+            fi
+          else
+            echo "No .cruft.json file"
+          fi
+
+          echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
+
+      - name: Run update if available
+        if: steps.check.outputs.has_changes == '1'
+        run: |
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+          git config --global user.name "${{ github.actor }}"
+
+          cruft update --skip-apply-ask --refresh-private-variables
+          git restore --staged .
+
+      - name: Create pull request
+        if: steps.check.outputs.has_changes == '1'
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          add-paths: ${{ matrix.add-paths }}
+          commit-message: ${{ matrix.commit-message }}
+          branch: ${{ matrix.branch }}
+          delete-branch: true
+          branch-suffix: timestamp
+          title: ${{ matrix.title }}
+          body: |
+            This is an autogenerated PR, which will ${{ matrix.body }}.
+            [Cruft](https://cruft.github.io/cruft/) has detected updates from the Package Template

.gitignore

@@ -24,11 +24,12 @@ parts/
 sdist/
 var/
 wheels/
+share/python-wheels/
 *.egg-info/
 .installed.cfg
 *.egg
 MANIFEST
-
+sunkit_instruments/_version.py
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
@@ -42,12 +43,14 @@ pip-delete-this-directory.txt
 # Unit test / coverage reports
 htmlcov/
 .tox/
+.nox/
 .coverage
 .coverage.*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
+*.py,cover
 .hypothesis/
 .pytest_cache/
 junit/
@@ -218,7 +221,6 @@ examples/**/*.csv
 figure_test_images*
 tags
 sunkit_instruments/_version.py
-docs/sg_execution_times.rst
 
 ### Pycharm(?)
 .idea
@@ -230,6 +232,7 @@ docs/sg_execution_times.rst
 .history
 *.orig
 .tmp
+requirements-min.txt
 
 # Example files
 dr_suvi-l2-thmap_g16_s20220101T000000Z_e20220101T000400Z_v1-0-2.fits

.isort.cfg

@@ -0,0 +1,16 @@
+[settings]
+balanced_wrapping = true
+skip =
+    docs/conf.py
+    sunkit_instruments/__init__.py
+default_section = THIRDPARTY
+include_trailing_comma = true
+known_astropy = astropy, asdf
+known_sunpy = sunpy
+known_first_party = sunkit_instruments
+length_sort = false
+length_sort_sections = stdlib
+line_length = 110
+multi_line_output = 3
+no_lines_before = LOCALFOLDER
+sections = STDLIB, THIRDPARTY, ASTROPY, SUNPY, FIRSTPARTY, LOCALFOLDER