fix: links for repo-review were sometimes off (#166)

* fix: links for repo-review were sometimes off

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

* fix: more corrections

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

* fix: updates to the README

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

* fix: RtD link on readme

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

* fix: webapp

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

---------

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

Author: henryiii

.pre-commit-config.yaml

@@ -67,7 +67,6 @@ repos:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
         args: [--prose-wrap=always]
-        exclude: ^docs/_includes/rr.html$
 
   - repo: https://github.com/codespell-project/codespell
     rev: "v2.2.4"

.readthedocs.yml

@@ -14,4 +14,6 @@ build:
     - asdf global ruby 3.1.2
     - gem install bundler
     - bundle install
-    - bundle exec jekyll build --destination _readthedocs/html --baseurl $(echo -n "$READTHEDOCS_CANONICAL_URL" | cut -d '/' -f 4-)
+    - >
+      bundle exec jekyll build --destination _readthedocs/html --baseurl $(echo
+      -n "$READTHEDOCS_CANONICAL_URL" | cut -d '/' -f 4-)

README.md

@@ -2,20 +2,23 @@
 
 [![Actions Status][actions-badge]][actions-link]
 [![GitHub Discussion][github-discussions-badge]][github-discussions-link]
+[![Live ReadTheDocs][rtd-badge]][rtd-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?
 
-- Designed from the [Scientific Python Developer Guide][]: Every decision is
+- Lives with the [Scientific Python Development Guide][]: Every decision is
   clearly documented and every tool described.
-- Template generation tested in GitHub Actions using nox.
 - 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.
+- 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.
 
-Be sure you have read the [Scientific Python Developer 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
@@ -44,7 +47,7 @@ During generation you can select from the following backends for your package:
    the right files included, little dynamic metadata support.
 9. [pdm][]: A modern, less opinionated all-in-one solution to pure Python
    projects supporting standards. Replaces setuptools, venv/pipenv, pip, wheel,
-   and twine. Supports [PEP 621][], and also the unaccepted [PEP 582][].
+   and twine. Supports [PEP 621][].
 10. [trampolim][]: A modern [PEP 621][] builder with support for tasks, allowing
     arbitrary Python to run during the build process if needed.
 11. [whey][]: A modern [PEP 621][] builder with some automation options for
@@ -62,7 +65,7 @@ otherwise with `pipx install cookiecutter` (or prepend `pipx run` to the command
 below, and skip installation). Then run:
 
 ```bash
-cookiecutter gh:scikit-hep/cookie
+cookiecutter gh:scientific-python/cookie
 ```
 
 You can also use `pipx run cookiecutter` without installing.
@@ -143,15 +146,21 @@ projects. It currently dumps all development dependencies into a shared
 environment, causing long solve times and high chance of conflicts. It also does
 not use pre-commit properly. It also has quite a bit of custom code.
 
+#### History
+
+A lot of the guide, cookiecutter, and repo-review started out as part of
+Scikit-HEP. These projects were merged, generalized, and combined with the
+NSLS-II guide during the 2023 Scientific-Python Developers Summit.
+
 <!-- prettier-ignore-start -->
 
 [actions-badge]: https://github.com/scikit-hep/cookie/workflows/CI/badge.svg
 [actions-link]: https://github.com/scikit-hep/cookie/actions
-[conda-badge]: https://img.shields.io/conda/vn/conda-forge/cookie
-[conda-link]: https://github.com/conda-forge/cookie-feedstock
 [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
-[scikit-hep developer guidelines]: https://scikit-hep.org/developer
+[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/
@@ -167,7 +176,6 @@ not use pre-commit properly. It also has quite a bit of custom code.
 [hypermodern]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
 [hatch]: https://github.com/ofek/hatch
 [meson-python]: https://meson-python.readthedocs.io
-[pep 582]: https://www.python.org/dev/peps/pep-0582
 [pep 621]: https://www.python.org/dev/peps/pep-0621
 
 <!-- prettier-ignore-end -->

docs/_includes/rr.html

@@ -1 +1,2 @@
-<span class="rr-btn" id="{{ include.id }}">{{ include.id }}</span>
+<!-- prettier-ignore -->
+<span class="rr-btn" id="{{ include.id }}">{{ include.id }}</span>

docs/assets/js/webapp.js

@@ -14,16 +14,16 @@ function Heading(props) {
             component="div"
             sx={{ flexGrow: 1 }}
           >
-            Scikit-HEP-Repo-Review
+            SP-Repo-Review
           </MaterialUI.Typography>
           <MaterialUI.Button
-            href="https://scientific-python-cookie.readthedocs.io"
+            href="https://learn.scientific-python.org/development"
             color="inherit"
           >
             Developer Guidelines
           </MaterialUI.Button>
           <MaterialUI.Button
-            href="https://github.com/scikit-hep/repo-review"
+            href="https://github.com/scientific-python/repo-review"
             color="inherit"
           >
             Source
@@ -34,6 +34,34 @@ function Heading(props) {
   );
 }
 
+function IfUrlLink({ name, url, color }) {
+  if (url) {
+    return (
+      <MaterialUI.Typography
+        sx={{ display: "inline" }}
+        component="span"
+        variant="body2"
+        color={color}
+        component="a"
+        href={url}
+        target="_blank"
+      >
+        {name}
+      </MaterialUI.Typography>
+    );
+  }
+  return (
+    <MaterialUI.Typography
+      sx={{ display: "inline" }}
+      component="span"
+      variant="body2"
+      color={color}
+    >
+      {name}
+    </MaterialUI.Typography>
+  );
+}
+
 function Results(props) {
   const output = [];
   for (const key in props.results) {
@@ -77,14 +105,8 @@ function Results(props) {
       );
       const msg = (
         <React.Fragment>
-          <MaterialUI.Typography
-            sx={{ display: "inline" }}
-            component="span"
-            variant="body2"
-            color={text_color}
-          >
-            {result.name + ": "}
-          </MaterialUI.Typography>
+          <IfUrlLink name={result.name} url={result.url} color={text_color} />
+          <IfUrlLink name={": "} url={""} color={text_color} />
           <React.Fragment>
             <MaterialUI.Typography
               sx={{ display: "inline" }}
@@ -100,7 +122,11 @@ function Results(props) {
       return (
         <MaterialUI.ListItem disablePadding key={result.name}>
           <MaterialUI.ListItemIcon>{icon}</MaterialUI.ListItemIcon>
-          <MaterialUI.ListItemText primary={msg} secondary={details} />
+          <MaterialUI.ListItemText
+            primary={msg}
+            secondary={details}
+            href={result.url}
+          />
         </MaterialUI.ListItem>
       );
     });
@@ -132,7 +158,7 @@ async function prepare_pyodide() {
   await pyodide.loadPackage("micropip");
   await pyodide.runPythonAsync(`
         import micropip
-        await micropip.install(["scikit_hep_repo_review==0.6.1"])
+        await micropip.install(["sp_repo_review==2023.06.01", "repo-review==0.7.0b4"])
     `);
   return pyodide;
 }
@@ -171,6 +197,7 @@ class App extends React.Component {
       msg: DEFAULT_MSG,
       progress: false,
       err_msg: "",
+      url: "",
     };
   }
 
@@ -199,8 +226,8 @@ class App extends React.Component {
       try {
         families_checks = pyodide.runPython(`
             from pyodide.http import open_url
-            from scikit_hep_repo_review.processor import process
-            from scikit_hep_repo_review.ghpath import GHPath
+            from repo_review.processor import process
+            from repo_review.ghpath import GHPath
 
             GHPath.open_url = staticmethod(open_url)
 
@@ -239,6 +266,7 @@ class App extends React.Component {
           description: val.description.toString(),
           state: val.result,
           err_msg: val.err_markdown().toString(),
+          url: val.url.toString(),
         });
       }
 
@@ -248,6 +276,7 @@ class App extends React.Component {
         msg: `Results for ${state.repo}@${state.branch}`,
         progress: false,
         err_msg: "",
+        url: "",
       });
 
       results_list.destroy();

docs/pages/guides/gha_basic.md

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: "GHA: GitHub Actions intro"
-permalink: /guides/gha_basic/
+permalink: /guides/gha-basic/
 nav_order: 11
 parent: Topical Guides
 custom_title: GitHub Actions introduction

docs/pages/guides/gha_pure.md

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: "GHA: Pure Python wheels"
-permalink: /guides/gha_pure/
+permalink: /guides/gha-pure/
 nav_order: 12
 parent: Topical Guides
 custom_title: GitHub Actions for pure Python wheels

docs/pages/guides/gha_wheels.md

@@ -1,7 +1,7 @@
 ---
 layout: page
 title: "GHA: Binary wheels"
-permalink: /guides/gha_wheels/
+permalink: /guides/gha-wheels/
 nav_order: 13
 parent: Topical Guides
 custom_title: GitHub Actions for Binary Wheels
@@ -39,10 +39,9 @@ click a button in the GUI to trigger a build, which is perfect for testing
 wheels before making a release; you can download them from "artifacts". You can
 even define variables that you can set in the GUI and access in the CI!
 
-[workflow_dispatch]:
-  https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/
-
 <!-- prettier-ignore-start -->
+[workflow_dispatch]: https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/
+
 ### Useful suggestion:
 {: .no_toc }
 <!-- prettier-ignore-end -->

docs/pages/guides/index.md

@@ -2,7 +2,7 @@
 layout: page
 title: Topical Guides
 permalink: /guides/
-nav_order: 3
+nav_order: 2
 has_children: true
 ---