Updates from package template (#183)

Co-authored-by: Nabil Freij <[email protected]>

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/sunpy/package-template",
-  "commit": "cd21e0d710513a891ed03f29e8afd6e0b9217f04",
+  "commit": "3737aa309d2a695ada046c7868c5683213003f3d",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -10,6 +10,12 @@
       "author_name": "The SunPy Developers",
       "author_email": "[email protected]",
       "project_url": "https://github.com/sunpy/streamtracer",
+      "github_repo": "",
+      "sourcecode_url": "",
+      "download_url": "https://pypi.org/project/streamtracer",
+      "documentation_url": "",
+      "changelog_url": "",
+      "issue_tracker_url": "",
       "license": "GNU GPL v3+",
       "minimum_python_version": "3.10",
       "use_compiled_extensions": "n",

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-
+# Main CI Workflow
 name: CI
 
 on:
@@ -37,7 +37,7 @@ jobs:
 
   core:
     needs: [rust]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
     with:
       submodules: false
       coverage: codecov
@@ -78,7 +78,7 @@ jobs:
 
   docs:
     needs: [core]
-    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
     with:
       default_python: '3.12'
       submodules: false
@@ -99,7 +99,7 @@ jobs:
         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
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
     with:
       default_python: '3.12'
       submodules: false

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
     # This should be before any formatting hooks like isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.7.4"
+    rev: "v0.8.1"
     hooks:
       - id: ruff
         args: ["--fix"]

.ruff.toml

@@ -38,7 +38,6 @@ extend-ignore = [
   "UP038", # Use | in isinstance - not compatible with models and is slower
   # pytest (PT)
   "PT001", # Always use pytest.fixture()
-  "PT004", # Fixtures which don't return anything should have leading _
   "PT023", # Always use () on pytest decorators
   # flake8-pie (PIE)
   "PIE808", # Disallow passing 0 as the first argument to range

CHANGELOG.rst

@@ -3,7 +3,7 @@
 
 * Add support for Python 3.13 `#176 <https://github.com/sunpy/streamtracer/pull/176>`__
 * Minor docstring formatting fixes, refactor input argument validation, and fix bug when tracing in +/-1 direction `#172 <https://github.com/sunpy/streamtracer/pull/172>`__
-* Buid binaries for aarch64 on native runners `#167 <https://github.com/sunpy/streamtracer/pull/167>`__
+* Build binaries for aarch64 on native runners `#167 <https://github.com/sunpy/streamtracer/pull/167>`__
 
 2.2.0
 =====

docs/conf.py

@@ -37,9 +37,11 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx_automodapi.automodapi",
     "sphinx.ext.napoleon",
     "jupyter_sphinx",
+    "sphinx.ext.mathjax",
+    "sphinx_automodapi.automodapi",
+    "sphinx_automodapi.smart_resolver",
     "sphinx_changelog",
 ]
 

docs/index.rst

@@ -9,7 +9,7 @@ The actual streamline tracing is done at a low level in Rust, with a nice Python
     :maxdepth: 1
 
     streamtracer
-    changelog
+    whatsnew/index
 
 Installing
 ==========

docs/changelog.rst → docs/whatsnew/changelog.rst

@@ -5,6 +5,6 @@ Full Changelog
 **************
 
 .. changelog::
-   :towncrier: ../
+   :towncrier: ../../
    :towncrier-skip-if-empty:
-   :changelog_file: ../CHANGELOG.rst
+   :changelog_file: ../../CHANGELOG.rst

docs/whatsnew/index.rst

@@ -0,0 +1,12 @@
+.. _whatsnew:
+
+***************
+Release History
+***************
+
+This page documents the releases for streamtracer
+
+.. toctree::
+   :maxdepth: 1
+
+   changelog

pyproject.toml

@@ -45,6 +45,7 @@ tests = [
 docs = [
   "sphinx",
   "sphinx-automodapi",
+  "sphinx-changelog",
   "sunpy-sphinx-theme",
   "packaging",
   "jupyter-sphinx",
@@ -53,6 +54,7 @@ docs = [
 
 [project.urls]
 Homepage = "https://docs.sunpy.org/projects/streamtracer"
+Download = "https://pypi.org/project/streamtracer"
 Documentation = "https://docs.sunpy.org/projects/streamtracer"
 Repository = "https://github.com/sunpy/streamtracer"
 
@@ -70,8 +72,10 @@ before-all = "curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stab
 [tool.cibuildwheel.macos]
 before-all = "rustup target add aarch64-apple-darwin"
 
-[tool.gilesbot]
+[tool.setuptools_scm]
+write_to = "streamtracer/version.py"
 
+[tool.gilesbot]
   [tool.gilesbot.pull_requests]
   enabled = true
 
@@ -80,11 +84,8 @@ before-all = "rustup target add aarch64-apple-darwin"
   verify_pr_number = true
   changelog_skip_label = "No Changelog Entry Needed"
   help_url = "https://github.com/sunpy/streamtracer/blob/main/changelog/README.rst"
-
-  changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/sunpy/streamtracer/blob/main/changelog/README.rst)."
-
-  type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/sunpy/streamtracer/blob/main/changelog/README.rst)"
-
+  changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com//blob/main/changelog/README.rst)."
+  type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com//blob/main/changelog/README.rst)"
   number_incorrect_long = "The number in the changelog file you added does not match the number of this pull request. Please rename the file."
 
 # TODO: This should be in towncrier.toml but Giles currently only works looks in