Addition of Cruft support

.github/workflows/sub_package_update.yml

@@ -0,0 +1,77 @@
+name: Update SunPy Sub Packages
+permissions:
+    contents: write
+    pull-requests: write
+
+on:
+  pull_request:
+    branches:
+      main
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - add-paths: .
+            body: Use this to merge the changes to the repo
+            branch: cruft/update
+            commit-message: "SunPy package template update"
+            title: New Updates to SunPy Template
+          - add-paths: .cruft.json
+            body: Use this to reject changes in the repo
+            branch: cruft/reject
+            commit-message: "Chore: reject this cruft update"
+            title: Reject new SunPy template updates
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install Cruft
+        run: pip3 install cruft
+
+      - 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'
+        # this needs to be sunpy details I think?
+        run: |
+          git config --global user.email ""
+          git config --global user.name "SunPy Org"
+
+          cruft update --skip-apply-ask --refresh-private-variables
+          git restore --staged
+
+      - name: Create pull request
+        if: steps.check.output.has_changes == '1'
+        uses: peter-evans/create-pull-request@v4
+        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. ${{ matrix.body }}
+              [Cruft](https://cruft.github.io/cruft/) has detected updates from the SunPy Package Template 
+

cookiecutter.json

@@ -26,6 +26,7 @@
     "_install_requires": "",
     "_copy_without_render": [
         "docs/_templates",
-        "docs/_static"
+        "docs/_static",
+        ".github/workflows/sub_package_update.yml"
     ]
 }

docs/index.rst

@@ -22,7 +22,21 @@ Using the Template
 
 With this guide is a `cookiecutter <https://cookiecutter.readthedocs.io/>`__ template which allows you to get started quickly with a package as described in this guide.
 
-To get started run:
+To create a new package based on the template run:
+
+.. code-block:: console
+   $ pip install cookiecutter cruft
+   $ cruft create https://github.com/OpenAstronomy/packaging-guide
+
+and go through the steps offered in the cli naming your package and filling in your details.
+Cruft is built on cookiecutter, and enables the updating of the template from the source.
+This takes the form of pull requests to the repository that the new package is pushed to.
+If a package already has a cookiecutter template, it can be linked to the parent repository using ``cruft link url-to-template``.
+
+To manually check whether the current environment matches with the template then ``cruft check`` will tell you what the current status is.
+``cruft update`` will manually trigger an updating of the package to the template.
+
+If you would like to stick to simply the cookiecutter approach, the template still supports that functionality thusly:
 
 .. code-block:: console
 

{{ cookiecutter.package_name }}/.github/workflows/sub_package_update.yml

@@ -0,0 +1,77 @@
+name: Update SunPy Sub Packages
+permissions:
+    contents: write
+    pull-requests: write
+
+on:
+  pull_request:
+    branches:
+      main
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - add-paths: .
+            body: Use this to merge the changes to the repo
+            branch: cruft/update
+            commit-message: "SunPy package template update"
+            title: New Updates to SunPy Template
+          - add-paths: .cruft.json
+            body: Use this to reject changes in the repo
+            branch: cruft/reject
+            commit-message: "Chore: reject this cruft update"
+            title: Reject new SunPy template updates
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install Cruft
+        run: pip3 install cruft
+
+      - 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'
+        # this needs to be sunpy details I think?
+        run: |
+          git config --global user.email ""
+          git config --global user.name "SunPy Org"
+
+          cruft update --skip-apply-ask --refresh-private-variables
+          git restore --staged
+
+      - name: Create pull request
+        if: steps.check.output.has_changes == '1'
+        uses: peter-evans/create-pull-request@v4
+        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. ${{ matrix.body }}
+              [Cruft](https://cruft.github.io/cruft/) has detected updates from the SunPy Package Template 
+

{{ cookiecutter.package_name }}/.gitignore

@@ -25,6 +25,11 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+{%- if cookiecutter.enable_dynamic_dev_versions == 'y' %}
+{{ cookiecutter.module_name }}/_version.py
+{% else %}
+{{ cookiecutter.module_name }}/version.py
+{% endif -%}
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

{{ cookiecutter.package_name }}/MANIFEST.in

@@ -5,9 +5,9 @@ prune build
 prune docs/_build
 prune docs/api
 global-exclude *.pyc *.o
-{% if cookiecutter.enable_dynamic_dev_versions == 'y' %}
+{%- if cookiecutter.enable_dynamic_dev_versions == 'y' %}
 
 # This subpackage is only used in development checkouts
 # and should not be included in built tarballs
 prune {{ cookiecutter.module_name }}/_dev
-{% endif %}
+{% endif -%}

{{ cookiecutter.package_name }}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-  "setuptools>=61.2",
+  "setuptools>=62.1",
   "setuptools_scm[toml]>=6.2",
   "wheel",
 {% if cookiecutter.use_compiled_extensions == 'y' %}
@@ -38,15 +38,15 @@ docs = [
     "tomli; python_version <\"3.11\"",
 ]
 
-{% if cookiecutter.include_example_code == 'y' %}
+{%0 if cookiecutter.include_example_code == 'y' %}
 [project.scripts]
 astropy_package_template_example = "{{ cookiecutter.module_name }}.example_mod:main"
-{% endif %}
+{% endif -%}
 
-{% if cookiecutter.project_url %}
+{%- if cookiecutter.project_url %}
 [project.urls]
 repository = "{{ cookiecutter.project_url }}"
-{% endif %}
+{% endif -%}
 
 [tool.setuptools]
 zip-safe = false
@@ -55,11 +55,11 @@ include-package-data = true
 [tool.setuptools.packages.find]
 
 [tool.setuptools_scm]
-{% if cookiecutter.enable_dynamic_dev_versions == 'y' %}
+{%- if cookiecutter.enable_dynamic_dev_versions == 'y' %}
 write_to = "{{ cookiecutter.module_name }}/_version.py"
 {% else %}
 write_to = "{{ cookiecutter.module_name }}/version.py"
-{% endif %}
+{% endif -%}
 
 
 [tool.pytest.ini_options]

{{ cookiecutter.package_name }}/setup.py

@@ -1,11 +1,11 @@
 #!/usr/bin/env python
 from setuptools import setup
-{% if cookiecutter.use_compiled_extensions == 'y' %}
+{%- if cookiecutter.use_compiled_extensions == 'y' %}
 from extension_helpers import get_extensions
-{% endif %}
+{% endif -%}
 
+{%- if cookiecutter.use_compiled_extensions == 'y' %}
 setup(
-{% if cookiecutter.use_compiled_extensions == 'y' %}
     ext_modules=get_extensions()
-{% endif %}
 )
+{% endif -%}