Increments python version

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directories:
+      - "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/workflows/oa_update.yml

@@ -0,0 +1,78 @@
+name: Automatic Update from OpenAstronomy/packging-guide
+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
+
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
+        with:
+          fetch-depth: 0
+
+      - name: Add OpenAstronomy/packaging-guide remote
+        run: |
+          git remote add openastronomy https://github.com/OpenAstronomy/packaging-guide.git
+          git remote update
+
+      - name: Check if there are new commits in OpenAstronomy/packaging-guide
+        continue-on-error: false
+        id: check
+        run: |
+          CHANGES=0
+          if [ "$(git rev-list HEAD..openastronomy/main --count)" -gt 0 ]; then
+              CHANGES=1
+          fi
+          echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
+
+      - name: Merge in OpenAstronomy/packaging-guide
+        if: steps.check.outputs.has_changes == '1'
+        id: merge
+        continue-on-error: false
+        run: |
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+          git config --global user.name "${{ github.actor }}"
+
+          git merge --no-edit --no-commit openastronomy/main || true
+          if [[ -n $(git ls-files --unmerged) ]]; then
+              CONFLICTS=1
+              # Commit the unresolved conflicts
+              git add .
+              git commit -m "Merge branch 'OpenAstronomy/main' into main (with unresolved conflicts)"
+          else
+              CONFLICTS=0
+              # No conflicts, commit the merge
+              git commit -m "Merge branch 'OpenAstronomy/main' into main"
+          fi
+          echo "has_conflicts=$CONFLICTS" >> "$GITHUB_OUTPUT"
+
+      - name: Create pull request
+        if: steps.check.outputs.has_changes == '1'
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e  # v7.0.8
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          draft: ${{ steps.merge.outputs.has_conflicts == '1' }}
+          delete-branch: true
+          branch-suffix: timestamp
+          title: "Updates from OpenAstronomy/packaging-guide"
+          body: |
+            This is an autogenerated PR, which merges commits from OpenAstronomy/packaging-guide.
+
+            ${{ steps.merge.outputs.has_conflicts == '1' && '**These changes have conflicts that need to be manually resolved.**' || '' }}
+
+            *Do not squash merge this PR! All commits from upstream should be present in the repos history.*

.github/workflows/pre-commit-update.yaml

@@ -0,0 +1,45 @@
+name: Update template pre-commit
+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 * *'  # First day of the month at 7am UTC
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+
+    steps:
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065  # v5.6.0
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      - name: Run pre-commit update
+        id: check
+        run: pre-commit autoupdate -c '{{ cookiecutter.package_name }}/.pre-commit-config.yaml'
+
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e  # v7.0.8
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          delete-branch: true
+          branch-suffix: timestamp
+          title: "pre-commit updates in the template"
+          body: |
+            This is an autogenerated PR, which updates the `{{ cookiecutter.package_name }}/.pre-commit-config.yaml` file.

.github/workflows/tests.yml

@@ -12,10 +12,18 @@ concurrency:
 
 jobs:
   test:
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@28e947497bed4d6ec3fa1d66d198e95a1d17bc63  # v2.2.1
     with:
       envs: |
         - macos: py311-test
         - linux: py312-test
         - linux: py313-test
         - linux: build_docs
+
+  bake_cookies:
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@28e947497bed4d6ec3fa1d66d198e95a1d17bc63  # v2.2.1
+    with:
+      artifact-path: |
+        cookies
+      envs: |
+        - linux: bake_cookies

.gitignore

@@ -143,3 +143,4 @@ dmypy.json
 # Just in case you want to test out the defaults in the repo
 packagename
 None/
+cookies

.pre-commit-config.yaml

@@ -14,3 +14,5 @@ repos:
         exclude: "{{ cookiecutter.package_name }}"
       - id: debug-statements
         exclude: "{{ cookiecutter.package_name }}"
+ci:
+  autofix_prs: false

README.rst

@@ -1,5 +1,10 @@
-OpenAstronomy Packaging Guide
-=============================
+SunPy Package Template
+======================
 
-The `OpenAstronomy Python Packaging Guide <https://packaging-guide.openastronomy.org/en/latest/>`__ that contains an embedded `cookiecutter <https://cookiecutter.readthedocs.io/>`__ template.
-Please see also the `instructions for using the template <https://packaging-guide.openastronomy.org/en/latest/#using-the-template>`__.
+This repo extends the `OpenAstronomy Python Packaging Guide <https://packaging-guide.openastronomy.org/en/latest/>`__ to add SunPy specific features such as config files which are shared over all of SunPy's packages.
+
+Previewing Rendered Templates
+-----------------------------
+
+To make it easier to preview changes to files when rendering the template there is a tox environment named ``bake_cookies``.
+If you run ``tox -e bake_cookies`` a new directory named ``cookies`` will be present with a variety of test renders of the template in (see ``tests/conftest.py`` for the configuration options).

cookiecutter.json

@@ -5,6 +5,12 @@
     "author_name": "",
     "author_email": "",
     "project_url": "",
+    "github_repo": "",
+    "sourcecode_url": "{{ 'https://github.com/' + cookiecutter.github_repo if cookiecutter.github_repo else '' }}",
+    "download_url": "https://pypi.org/project/{{ cookiecutter.package_name }}",
+    "documentation_url": "",
+    "changelog_url": "",
+    "issue_tracker_url": "{{ 'https://github.com/' + cookiecutter.github_repo + '/issues/' if cookiecutter.github_repo else '' }}",
     "license": [
         "BSD 3-Clause",
         "GNU GPL v3+",
@@ -22,12 +28,22 @@
     "enable_dynamic_dev_versions": "n",
     "include_example_code": "n",
     "include_cruft_update_github_workflow": "n",
-    "_sphinx_theme": "alabaster",
+    "use_extended_ruff_linting": "n",
+    "_sphinx_theme": "sunpy",
     "_parent_project": "",
     "_install_requires": "",
     "_copy_without_render": [
         "docs/_templates",
         "docs/_static",
         ".github/workflows/sub_package_update.yml"
-    ]
+    ],
+    "__prompts__" : {
+        "project_url": "Primary website for the project, leave blank for Sunpy Homepage",
+        "github_repo": "user/repo format GitHub repository. Leave blank if project is not on GitHub.",
+        "sourcecode_url": "URL for source code, i.e. https://github.com/...",
+        "download_url": "PyPI address for the project, optional",
+        "documentation_url": "Documentation URL, optional",
+        "changelog_url": "URL to the changelog, optional",
+        "issue_tracker_url": "URL to the issue tracker, optional"
+    }
 }

docs/conf.py

@@ -36,20 +36,15 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
+# Treat everything in single ` as a Python reference.
+default_role = 'py:obj'
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
-
-html_theme_options = {
-    "description": "A generic Python packaging guide and template.",
-    "code_font_family": "'Fira Code', monospace",
-    "github_user": "OpenAstronomy",
-    "github_repo": "packaging-guide",
-    "sidebar_width": "300px"
-}
+html_theme = 'sunpy'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.rst

@@ -27,7 +27,7 @@ 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
+   $ cruft create https://github.com/sunpy/package-template
 
 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.
@@ -42,7 +42,7 @@ If you would like to stick to simply the cookiecutter approach, the template sti
 .. code-block:: console
 
    $ pip install cookiecutter
-   $ cookiecutter gh:OpenAstronomy/packaging-guide -o ./output_directory
+   $ cookiecutter gh:sunpy/package-template -o ./output_directory
 
 This will create a new directory in your current directory named the same as the value of "packagename" you supplied.
 Change into this directory and run ``git init`` to make it into a git repository, and make an initial commit.
@@ -54,3 +54,49 @@ The template currently implements the following optional flags, all of which def
 * ``include_example_code``: This option will fill your new package with some example functions to allow you to test it.
 * ``use_compiled_extensions``: This turns on the features needed to support compiled extensions as described in :ref:`extensions`.
 * ``enable_dynamic_dev_versions``: This enables a feature which ensures that ``my_package.__version__`` always returns the current git version as calculated by ``setuptools_scm`` when the package is installed as an editable install. See :ref:`dev-versions` for more details.
+* ``include_cruft_update_github_repo``: This option adds a github workflow with pulls in the latest changes from the template every Monday morning and creates a PR against the repo which can then be accepted or closed.
+* ``use_extended_ruff_linting``: This option flag enables the stricter ruff rules. Recommend `Y` on creation of a new project.
+
+Pre-commit
+==========
+
+Pre-commit is configured through ``.pre-commit-config.yaml`` and can be installed locally and ran:
+
+.. code-block:: bash
+
+    $ pre-commit run --all-files
+
+It also possible to use the tox environment to run it and and is integrated into the CI.
+
+Within ``.pre-commit-config.yaml``, there are several tools and each one is configured either within the ``.pre-commit-config.yaml`` or for larger tools like ruff, it is has a dedicated config file ``.ruff.toml`` and we strongly recommend using the full set of rules when you setup your package.
+
+Updating to a new version of the template
+=========================================
+
+It will be simplest to updating a package to a newer template by waiting for the GitHub workflow to trigger.
+This will trigger a pull request one can review and merge via GitHub's UI.
+
+If you do not want to wait, or want to do it manually, you will have to use cruft's CLI.
+For this you will need to install cruft locally and then you can check the status of the package by running:
+
+.. code-block:: console
+
+    $ cruft check
+
+This will let you know whether the repository is up to date or not.
+From there, you can run:
+
+.. code-block:: console
+
+    $ cruft update
+
+To update the repo and if there is a case conflicting files, ``.rej`` files will be created and you will have to manually deal with them and merge changes.
+
+If you need up update one of the variables in the package ``.cruft.json`` for example, changing a ``n`` to a ``y`` this can be done using:
+
+.. code-block:: console
+
+    $ cruft update --variables-to-update '{"use_extended_ruff_linting": "y"}'
+
+This will work through the codebase and include the desired functionality without any further action.
+Then you can commit and push the resulting changes.

docs/rtd_environment.yaml

@@ -1,8 +1,10 @@
-name: rtd311
+name: rtd313
 channels:
  - conda-forge
  - defaults
 dependencies:
- - python=3.11
+ - python=3.13
  - pip
  - graphviz
+ - pip:
+    - sunpy-sphinx-theme

hooks/post_gen_project.py

@@ -37,7 +37,7 @@ def process_version(enable_dynamic_dev_versions):
 
 def process_github_workflow(include_cruft_update_github_workflow):
     if include_cruft_update_github_workflow != "y":
-        remove_dir(os.path.join(PROJECT_DIRECTORY,  '.github'))
+        remove_file(os.path.join(PROJECT_DIRECTORY,  '.github', 'workflows', 'sub_package_update.yml'))
 
 
 if __name__ == '__main__':