chore: update repo review handling (#167)

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: henryiii

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -0,0 +1 @@
+.git_archival.txt  export-subst

.github/workflows/cd.yml

@@ -13,20 +13,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-
-      - uses: actions/setup-python@v4
         with:
-          python-version: "3.x"
-
-      - name: Build sdist and wheel
-        run: pipx run build
-
-      - uses: actions/upload-artifact@v3
-        with:
-          path: dist
+          fetch-depth: 0
 
-      - name: Check products
-        run: pipx run twine check dist/*
+      - uses: hynek/build-and-inspect-python-package@v1
 
   publish:
     name: Publish
@@ -41,7 +31,7 @@ jobs:
     steps:
       - uses: actions/download-artifact@v3
         with:
-          name: artifact
+          name: Packages
           path: dist
 
       - uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/reusable-rr-tests.yml

@@ -18,6 +18,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - uses: actions/setup-python@v4
         with:
@@ -30,3 +32,14 @@ jobs:
         run: python -m pytest -ra
         env:
           PYTHONUTF8: "1"
+
+  action:
+    name: Action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Run sp-repo-review action
+        uses: ./

.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+id: sp-repo-review
+name: sp-repo-review
+description: Check for configuration best practices
+entry: repo-review
+language: python
+types_or: [text]
+minimum_pre_commit_version: 2.9.0

README-rr.md

@@ -0,0 +1,50 @@
+# sp-repo-review
+
+[![Actions Status][actions-badge]][actions-link]
+[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
+[![Live ReadTheDocs][rtd-badge]][rtd-link]
+
+[![PyPI version][pypi-version]][pypi-link]
+[![PyPI platforms][pypi-platforms]][pypi-link]
+
+`sp-repo-review` provides checks based on the [Scientific-Python Development
+Guide][] at [scientific-python/cookie][].
+
+This tool can check the style of a repository. Use like this:
+
+```bash
+pipx run 'sp-repo-review[cli]' <path to repository>
+```
+
+This will produce a list of results - green checkmarks mean this rule is
+followed, red x’s mean the rule is not. A yellow warning sign means that the
+check was skipped because a previous required check failed. Some checks will
+fail, that’s okay - the goal is bring all possible issues to your attention, not
+to force compliance with arbitrary checks. Eventually there might be a way to
+mark checks as ignored.
+
+For example, `GH101` expects all your action files to have a nice `name:` field.
+If you are happy with the file-based names you see in CI, you should feel free
+to simply ignore this check (just visually ignore it for the moment, a way to
+specify ignored checks will likely be added eventually).
+
+All checks are mentioned at least in some way in the [Scientific-Python
+Development Guide][]. You should read that first - if you are not attempting to
+follow them, some of the checks might not work. For example, the guidelines
+specify pytest configuration be placed in `pyproject.toml`. If you place it
+somewhere else, then all the pytest checks will be skipped.
+
+<!-- prettier-ignore-start -->
+
+[actions-badge]: https://github.com/scientific-python/cookie/workflows/CI/badge.svg
+[actions-link]: https://github.com/scientific-python/cookie/actions
+[pypi-link]: https://pypi.org/project/sp-repo-review/
+[pypi-platforms]: https://img.shields.io/pypi/pyversions/sp-repo-review
+[pypi-version]: https://badge.fury.io/py/sp-repo-review.svg
+[docs-badge]: https://readthedocs.org/projects/scientific-python-cookie/badge/?version=latest
+[docs-link]: https://scientific-python-cookie.readthedocs.io/en/latest/?badge=latest
+[scientific-python development guide]: https://learn.scientific-python.org/development
+[scientific-python/cookie]: https://github.com/scientific-python/cookie
+[scikit-hep]: https://scikit-hep.org
+
+<!-- prettier-ignore-end -->

README.md

@@ -4,21 +4,25 @@
 [![GitHub Discussion][github-discussions-badge]][github-discussions-link]
 [![Live ReadTheDocs][rtd-badge]][rtd-link]
 
+[![PyPI version][pypi-version]][pypi-link]
+[![PyPI platforms][pypi-platforms]][pypi-link]
+
 A cookiecutter template for new Python projects based on the Scientific Python
 Developer Guide. What makes this different from other cookie cutter templates
 for Python packages?
 
-- Lives with the [Scientific Python Development Guide][]: Every decision is
+- Lives with the [Scientific-Python Development Guide][]: Every decision is
   clearly documented and every tool described.
 - Twelve different backends to choose from for building packages.
 - Template generation tested in GitHub Actions using nox.
 - Includes several compiled backends using pybind11, with wheels produced for
   all platforms using cibuildwheel.
 - Follows PyPA best practices and regularly updated.
-- Provides `sp-repo-review` to evaluate existing repos against the guidelines,
-  with a WebAssembly version integrated with the guide. All checks cross-linked.
+- Provides [`sp-repo-review`][pypi-link] to evaluate existing repos against the
+  guidelines, with a WebAssembly version integrated with the guide. All checks
+  cross-linked.
 
-Be sure you have read the [Scientific Python Development Guide][] first, and
+Be sure you have read the [Scientific-Python Development Guide][] first, and
 possibly used them on a project or two. This is _not_ a minimal example or
 tutorial. It is a collection of useful tooling for starting a new project using
 cookiecutter, or for copying in individual files for an existing project (by
@@ -156,26 +160,29 @@ NSLS-II guide during the 2023 Scientific-Python Developers Summit.
 
 [actions-badge]: https://github.com/scikit-hep/cookie/workflows/CI/badge.svg
 [actions-link]: https://github.com/scikit-hep/cookie/actions
-[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
-[github-discussions-link]: https://github.com/scikit-hep/cookie/discussions
-[rtd-badge]: https://readthedocs.org/projects/scientific-python-cookie/badge/?version=latest
-[rtd-link]: https://scientific-python-cookie.readthedocs.io/en/latest/?badge=latest
-[scientific-python development guide]: https://learn.scientific-python.org/development
 [cibuildwheel]: https://cibuildwheel.readthedocs.io/en/stable/
-[scikit-build]: https://scikit-build.readthedocs.io/en/latest/
 [flit]: https://flit.readthedocs.io/en/latest/
+[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
+[github-discussions-link]: https://github.com/scikit-hep/cookie/discussions
+[hatch]: https://github.com/ofek/hatch
+[hypermodern]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
+[maturin]: https://maturin.rs
+[meson-python]: https://meson-python.readthedocs.io
 [nox]: https://nox.thea.codes/en/stable/
 [pdm]: https://pdm.fming.dev
+[pep 621]: https://www.python.org/dev/peps/pep-0621
+[pipx]: https://pypa.github.io/pipx/
 [poetry]: https://python-poetry.org
 [pybind11]: https://pybind11.readthedocs.io/en/stable/
+[pypi-link]: https://pypi.org/project/sp-repo-review/
+[pypi-platforms]: https://img.shields.io/pypi/pyversions/sp-repo-review
+[pypi-version]: https://badge.fury.io/py/sp-repo-review.svg
+[rtd-badge]: https://readthedocs.org/projects/scientific-python-cookie/badge/?version=latest
+[rtd-link]: https://scientific-python-cookie.readthedocs.io/en/latest/?badge=latest
+[scientific-python development guide]: https://learn.scientific-python.org/development
+[scikit-build]: https://scikit-build.readthedocs.io/en/latest/
 [setuptools]: https://setuptools.readthedocs.io/en/latest/
 [trampolim]: https://trampolim.readthedocs.io/en/latest/
-[pipx]: https://pypa.github.io/pipx/
 [whey]: https://whey.readthedocs.io/en/latest/
-[maturin]: https://maturin.rs
-[hypermodern]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
-[hatch]: https://github.com/ofek/hatch
-[meson-python]: https://meson-python.readthedocs.io
-[pep 621]: https://www.python.org/dev/peps/pep-0621
 
 <!-- prettier-ignore-end -->

action.yml

@@ -0,0 +1,30 @@
+name: sp-repo-review
+description: "Runs sp-repo-review"
+inputs:
+  package-dir:
+    description: "Path to Python package, if different from repo root"
+    required: false
+    default: ""
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/setup-python@v4
+      id: python
+      with:
+        python-version: "3.11"
+        update-environment: false
+
+    # prettier-ignore
+    - name: Run repo-review
+      shell: bash
+      run: >
+        pipx run
+        --python '${{ steps.python.outputs.python-path }}'
+        --spec '${{ github.action_path }}[cli]'
+        repo-review .
+        --stderr html
+        --select "${{ inputs.select }}"
+        --ignore "${{ inputs.ignore }}"
+        --package-dir "${{ inputs.package-dir }}"
+        >> $GITHUB_STEP_SUMMARY

docs/_includes/interactive_repo_review.html

@@ -16,5 +16,10 @@
   const root = ReactDOM.createRoot(
     document.getElementById("interactive-repo-review-root")
   );
-  root.render(<App header={false} />);
+  root.render(
+    <App
+      header={false}
+      deps={["sp_repo_review==2023.06.01", "repo-review==0.7.0b8"]}
+    />
+  );
 </script>

docs/assets/js/webapp.js

@@ -14,14 +14,8 @@ function Heading(props) {
             component="div"
             sx={{ flexGrow: 1 }}
           >
-            SP-Repo-Review
+            Repo-Review
           </MaterialUI.Typography>
-          <MaterialUI.Button
-            href="https://learn.scientific-python.org/development"
-            color="inherit"
-          >
-            Developer Guidelines
-          </MaterialUI.Button>
           <MaterialUI.Button
             href="https://github.com/scientific-python/repo-review"
             color="inherit"
@@ -152,19 +146,18 @@ function Results(props) {
   );
 }
 
-async function prepare_pyodide() {
+async function prepare_pyodide(deps) {
+  const deps_str = deps.map((i) => `"${i}"`).join(", ");
   const pyodide = await loadPyodide();
 
   await pyodide.loadPackage("micropip");
   await pyodide.runPythonAsync(`
         import micropip
-        await micropip.install(["sp_repo_review==2023.06.01", "repo-review==0.7.0b4"])
+        await micropip.install([${deps_str}])
     `);
   return pyodide;
 }
 
-const pyodide_promise = prepare_pyodide();
-
 function MyThemeProvider(props) {
   const prefersDarkMode = MaterialUI.useMediaQuery(
     "(prefers-color-scheme: dark)"
@@ -190,15 +183,17 @@ function MyThemeProvider(props) {
 class App extends React.Component {
   constructor(props) {
     super(props);
+    const deps_str = props.deps.map((i) => `"${i}"`).join(", ");
     this.state = {
       results: [],
       repo: urlParams.get("repo") || "",
       branch: urlParams.get("branch") || "",
-      msg: DEFAULT_MSG,
+      msg: `${DEFAULT_MSG} Packages: ${deps_str}`,
       progress: false,
       err_msg: "",
       url: "",
     };
+    this.pyodide_promise = prepare_pyodide(props.deps);
   }
 
   handleCompute() {
@@ -221,7 +216,7 @@ class App extends React.Component {
       progress: true,
     });
     const state = this.state;
-    pyodide_promise.then((pyodide) => {
+    this.pyodide_promise.then((pyodide) => {
       var families_checks;
       try {
         families_checks = pyodide.runPython(`