Merge pull request #27 from sandialabs/final-tweaks

jmgate · web-flow · commit 59cf4d25fd9f · 2024-07-02T08:21:22.000-06:00
Final tweaks
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -40,13 +40,27 @@ jobs:
         run: python3 -m pip install .
 
       - name: Test with pytest
-        run: python3 -m pytest --cov=staged_script test/
+        run: python3 -m pytest --cov=staged_script example/ test/
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+      - name: Check documentation spelling
+        run: make spelling
+        working-directory: ./doc
+
+      - name: Check documentation coverage
+        run: make coverage
+        working-directory: ./doc
+
+      - name: Archive documentation coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs-coverage-report
+          path: doc/build/coverage/python.txt
+
       - name: Test uninstall
         run: python3 -m pip uninstall -y reverse_argparse
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -10,7 +10,6 @@ repos:
       rev: v0.5.0
       hooks:
         - id: ruff
-          args: [ --fix ]
         - id: ruff-format
 
     - repo: https://github.com/pre-commit/mirrors-mypy
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -23,3 +23,4 @@ python:
       path: .
     - requirements: requirements.txt
     - requirements: doc/requirements.txt
+    - requirements: example/requirements.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+# CHANGELOG
+
+
+
+## v1.0.0 (2024-06-25)
+This file will be overwritten when Semantic Release next runs.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,10 +1,5 @@
 # Contributing to `staged-script`
 
-> **Usage Guidelines:**
->
-> * Review all the text and add/remove/adjust things as needed.
-> * Delete this note.
-
 Thanks so much for your willingness to help out with `staged-script`'s
 development :grinning:  Here's everything you need to know.
 
@@ -77,6 +72,7 @@ The checks we perform are the following:
 * Use [ruff][ruff] to lint and format the code and docstrings.
 * Use [mypy][mypy] to run static type checking on our type-hinted code.
 * Ensure no large files are added to the repository.
+* Ensure files parse as valid Python.
 * Check for files that would conflict in case-sensitive filesystems.
 * Ensure files don't contain merge conflict strings.
 * Ensure files end with a single blank line.
@@ -87,8 +83,6 @@ The checks we perform are the following:
 * Use [doc8][doc8] to enforce our style for our documentation.
 * Use [pyroma][pyroma] to ensure our package complies with the best practices
   of the Python packaging ecosystem.
-* INSERT OTHERS
-* AS NEEDED
 
 [ruff]: https://docs.astral.sh/ruff/
 [mypy]: https://github.com/python/mypy
@@ -142,12 +136,12 @@ search for and install them.  These are the ones we recommend:
   [GitKraken][kraken] into VS Code.
 * **IntelliCode:**  AI-assisted development features.
 * **Pre-Commit:**  Commands and helpers for executing pre-commit hooks.
+* **Test Adapter Converter:**  Converts from the Test Explorer UI (below) API
+  to native VS Code testing.
 * **Test Explorer UI:**  Extensible user interface for running your tests in VS
   Code.
 * **Vim:**  For when you can't truly leave vi behind (and who would want to?).
 * **vscode-icons:**  Icons for the file explorer.
-* INSERT OTHERS
-* AS NEEDED
 
 [conventional]: https://www.conventionalcommits.org/en/v1.0.0/
 [kraken]: https://www.gitkraken.com/
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -6,3 +6,4 @@ sphinx-copybutton
 sphinx-rtd-theme
 sphinxcontrib-mermaid
 sphinxcontrib-programoutput
+sphinxcontrib-spelling
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -33,6 +33,7 @@
     "sphinx_rtd_theme",
     "sphinxcontrib.mermaid",
     "sphinxcontrib.programoutput",
+    "sphinxcontrib.spelling",
 ]
 intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
diff --git a/doc/source/spelling_wordlist.txt b/doc/source/spelling_wordlist.txt
@@ -0,0 +1,8 @@
+pre
+erroring
+retryable
+programmatically
+linters
+namespace
+argparse
+ArgumentGroup
diff --git a/example/ex_0_the_basics.py b/example/ex_0_the_basics.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A very basic staged script."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/ex_1_removing_the_retry_arguments.py b/example/ex_1_removing_the_retry_arguments.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A staged script without retry arguments."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/ex_2_running_certain_stages_by_default.py b/example/ex_2_running_certain_stages_by_default.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A staged script that runs certain stages by default."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/ex_3_adding_arguments.py b/example/ex_3_adding_arguments.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A staged script with additional arguments."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/ex_4_customizing_stage_behavior.py b/example/ex_4_customizing_stage_behavior.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A staged script with custom stage behavior."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/ex_5_customizing_individual_stages.py b/example/ex_5_customizing_individual_stages.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A staged script with phases customized per stage."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/ex_6_creating_retryable_stages.py b/example/ex_6_creating_retryable_stages.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A staged script with a retryable stage."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/ex_7_customizing_the_summary.py b/example/ex_7_customizing_the_summary.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python3
 """A staged script with a retryable stage."""
 
 # © 2024 National Technology & Engineering Solutions of Sandia, LLC
diff --git a/example/requirements.txt b/example/requirements.txt
@@ -0,0 +1 @@
+# Requirements for running the `staged-script` examples.
diff --git a/example/test_examples.py b/example/test_examples.py
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/staged_script/py.typed b/staged_script/py.typed
diff --git a/templates/.release_notes.md.j2 b/templates/.release_notes.md.j2
diff --git a/templates/CHANGELOG.md.j2 b/templates/CHANGELOG.md.j2

Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`"sphinx_rtd_theme",`
`34`	`34`	`"sphinxcontrib.mermaid",`
`35`	`35`	`"sphinxcontrib.programoutput",`
	`36`	`+ "sphinxcontrib.spelling",`
`36`	`37`	`]`
`37`	`38`	`intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}`
`38`	`39`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#!/usr/bin/env python3`
`1`	`2`	`"""A very basic staged script."""`
`2`	`3`
`3`	`4`	`# © 2024 National Technology & Engineering Solutions of Sandia, LLC`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+#!/usr/bin/env python3`
`1`	`2`	`"""A staged script without retry arguments."""`
`2`	`3`
`3`	`4`	`# © 2024 National Technology & Engineering Solutions of Sandia, LLC`