feat: combined readme with check list

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

.github/workflows/reusable-change-detection.yml

@@ -33,6 +33,8 @@ jobs:
  noxfile.py
  hooks/**
  cookiecutter.json
+ copier.yml
+ extensions.py
  - name: Set a flag for running the tests
  if: >-
  github.event_name != 'pull_request' ||
@@ -47,12 +49,13 @@ jobs:
  with:
  format: "json"
  filter: |
- tests/**
  .github/workflows/ci.yml
  .github/workflows/reusable-rr-tests.yml
+ README.md
  noxfile.py
- src/**
  pyproject.toml
+ src/**
+ tests/**
  - name: Set a flag for running the tests
  if: >-
  github.event_name != 'pull_request' ||

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

@@ -43,3 +43,20 @@ jobs:
 
  - name: Run sp-repo-review action
  uses: ./
+
+ cog:
+ name: Run cog on README
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ fetch-depth: 0
+
+ - uses: actions/setup-python@v4
+ with:
+ python-version: "3.11"
+
+ - name: Rerender README
+ run: |
+ pipx run nox -s readme
+ git diff --exit-code

README.md

@@ -1,4 +1,6 @@
-# Scientific Python: cookie
+# Scientific Python: guide, cookie, & sp-repo-review
+
+## Cookie
 
 [![Actions Status][actions-badge]][actions-link]
 [![GitHub Discussion][github-discussions-badge]][github-discussions-link]
@@ -204,11 +206,153 @@ A lot of the guide, cookiecutter, and repo-review started out as part of
 [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
-[scikit-hep]: https://scikit-hep.org
 [setuptools]: https://setuptools.readthedocs.io
 [trampolim]: https://trampolim.readthedocs.io
 [whey]: https://whey.readthedocs.io
 
 <!-- prettier-ignore-end -->
+
+---
+
+## sp-repo-review
+
+<!-- sp-repo-review -->
+
+`sp-repo-review` provides checks based on the [Scientific-Python Development
+Guide][] at [scientific-python/cookie][] for [repo-review][].
+
+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.
+
+This was originally developed for [Scikit-HEP][] before moving to Scientific
+Python.
+
+## Other ways to use
+
+You can also use GitHub Actions:
+
+```yaml
+- uses: scientific-python/cookie@<version>
+```
+
+Or pre-commit:
+
+```yaml
+- repo: https://github.com/scientific-python/cookie
+ rev: <version>
+ hooks:
+ - id: sp-repo-review
+```
+
+## List of checks
+
+<!-- prettier-ignore-start -->
+
+<!-- [[[cog
+import itertools
+
+from repo_review.processor import collect_all
+from repo_review.checks import get_check_url, get_check_description
+from repo_review.families import get_family_name
+
+collected = collect_all()
+print()
+for family, grp in itertools.groupby(collected.checks.items(), key=lambda x: x[1].family):
+ print(f'### {get_family_name(collected.families, family)}')
+ for code, check in grp:
+ url = get_check_url(code, check)
+ link = f"[`{code}`]({url})" if url else f"`{code}`"
+ print(f"- {link}: {get_check_description(code, check)}")
+ print()
+]]] -->
+
+### General
+- [`PY001`](https://learn.scientific-python.org/development/guides/packaging-simple#PY001): Has a pyproject.toml
+- [`PY002`](https://learn.scientific-python.org/development/guides/packaging-simple#PY002): Has a README.(md|rst) file
+- [`PY003`](https://learn.scientific-python.org/development/guides/packaging-simple#PY003): Has a LICENSE* file
+- [`PY004`](https://learn.scientific-python.org/development/guides/packaging-simple#PY004): Has docs folder
+- [`PY005`](https://learn.scientific-python.org/development/guides/packaging-simple#PY005): Has tests folder
+- [`PY006`](https://learn.scientific-python.org/development/guides/style#PY006): Has pre-commit config
+- [`PY007`](https://learn.scientific-python.org/development/guides/tasks#PY007): Supports an easy task runner (nox or tox)
+
+### PyProject
+- [`PP002`](https://learn.scientific-python.org/development/guides/packaging-simple#PP002): Has a proper build-system table
+- [`PP003`](https://learn.scientific-python.org/development/guides/packaging-classic#PP003): Does not list wheel as a build-dep
+- [`PP301`](https://learn.scientific-python.org/development/guides/pytest#PP301): Has pytest in pyproject
+- [`PP302`](https://learn.scientific-python.org/development/guides/pytest#PP302): Sets a minimum pytest to at least 6
+- [`PP303`](https://learn.scientific-python.org/development/guides/pytest#PP303): Sets the test paths
+- [`PP304`](https://learn.scientific-python.org/development/guides/pytest#PP304): Sets the log level in pytest
+- [`PP305`](https://learn.scientific-python.org/development/guides/pytest#PP305): Specifies xfail_strict
+- [`PP306`](https://learn.scientific-python.org/development/guides/pytest#PP306): Specifies strict config
+- [`PP307`](https://learn.scientific-python.org/development/guides/pytest#PP307): Specifies strict markers
+- [`PP308`](https://learn.scientific-python.org/development/guides/pytest#PP308): Specifies useful pytest summary
+- [`PP309`](https://learn.scientific-python.org/development/guides/pytest#PP309): Filter warnings specified
+
+### GitHub Actions
+- [`GH100`](https://learn.scientific-python.org/development/guides/gha-basic#GH100): Has GitHub Actions config
+- [`GH101`](https://learn.scientific-python.org/development/guides/gha-basic#GH101): Has nice names
+- [`GH102`](https://learn.scientific-python.org/development/guides/gha-basic#GH102): Auto-cancel on repeated PRs
+- [`GH103`](https://learn.scientific-python.org/development/guides/gha-basic#GH103): At least one workflow with manual dispatch trigger
+- [`GH200`](https://learn.scientific-python.org/development/guides/gha-basic#GH200): Maintained by Dependabot
+- [`GH210`](https://learn.scientific-python.org/development/guides/gha-basic#GH210): Maintains the GitHub action versions with Dependabot
+- [`GH211`](https://learn.scientific-python.org/development/guides/gha-basic#GH211): Do not pin core actions as major versions
+
+### MyPy
+- [`MY100`](https://learn.scientific-python.org/development/guides/style#MY100): Uses MyPy (pyproject config)
+- [`MY101`](https://learn.scientific-python.org/development/guides/style#MY101): MyPy strict mode
+- [`MY102`](https://learn.scientific-python.org/development/guides/style#MY102): MyPy show error codes
+- [`MY103`](https://learn.scientific-python.org/development/guides/style#MY103): MyPy warn unreachable
+- [`MY104`](https://learn.scientific-python.org/development/guides/style#MY104): MyPy enables ignore-without-code
+- [`MY105`](https://learn.scientific-python.org/development/guides/style#MY105): MyPy enables redundant-expr
+- [`MY106`](https://learn.scientific-python.org/development/guides/style#MY106): MyPy enables truthy-bool
+
+### Pre-commit
+- [`PC100`](https://learn.scientific-python.org/development/guides/style#PC100): Has pre-commit-hooks
+- [`PC110`](https://learn.scientific-python.org/development/guides/style#PC110): Uses black
+- [`PC111`](https://learn.scientific-python.org/development/guides/style#PC111): Uses blacken-docs
+- [`PC140`](https://learn.scientific-python.org/development/guides/style#PC140): Uses mypy
+- [`PC160`](https://learn.scientific-python.org/development/guides/style#PC160): Uses codespell
+- [`PC170`](https://learn.scientific-python.org/development/guides/style#PC170): Uses PyGrep hooks (only needed if RST present)
+- [`PC180`](https://learn.scientific-python.org/development/guides/style#PC180): Uses prettier
+- [`PC190`](https://learn.scientific-python.org/development/guides/style#PC190): Uses Ruff
+- [`PC191`](https://learn.scientific-python.org/development/guides/style#PC191): Ruff show fixes if fixes enabled
+- [`PC901`](https://learn.scientific-python.org/development/guides/style#PC901): Custom pre-commit CI message
+
+### Ruff
+- [`RF001`](https://learn.scientific-python.org/development/guides/style#RF001): Has Ruff config
+- [`RF002`](https://learn.scientific-python.org/development/guides/style#RF002): Target version must be set
+- [`RF003`](https://learn.scientific-python.org/development/guides/style#RF003): src directory specified if used
+- [`RF101`](https://learn.scientific-python.org/development/guides/style#RF101): Bugbear must be selected
+- [`RF102`](https://learn.scientific-python.org/development/guides/style#RF102): isort must be selected
+- [`RF103`](https://learn.scientific-python.org/development/guides/style#RF103): pyupgrade must be selected
+
+<!-- [[[end]]] -->
+
+[repo-review]: https://repo-review.readthedocs.io
+[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 -->

docs/pages/guides/gha_pure.md

@@ -58,9 +58,6 @@ releases(-only). You will also need to change the event filter below.
 You can merge the CI job and the CD job if you want. To do that, preferably with
 the name "CI/CD", you can just combine the two `on` dicts.
 
-[`workflow_dispatch`]:
- https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/
-
 ## Distribution: Pure Python wheels
 
 {% raw %}
@@ -319,6 +316,8 @@ jobs:
 [pep 517]: https://www.python.org/dev/peps/pep-0517/
 [pep 518]: https://www.python.org/dev/peps/pep-0518/
 [pypi trusted publisher docs]: https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/
+[`workflow_dispatch`]: https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/
+
 
 <!-- prettier-ignore-end -->
 

noxfile.py

@@ -18,6 +18,7 @@
 import nox
 
 nox.needs_version = ">=2022.1.7"
+nox.options.sessions = ["rr-lint", "rr-tests", "rr-pylint", "readme"]
 
 DIR = Path(__file__).parent.resolve()
 with DIR.joinpath("cookiecutter.json").open() as f:
@@ -29,8 +30,6 @@
  backend: {backend}
 """
 
-nox.options.sessions = ["lint", "tests", "native"]
-
 
 def make_copier(session: nox.Session, backend: str) -> None:
  package_dir = Path(f"copy-{backend}")
@@ -324,13 +323,26 @@ def gha_bump(session: nox.Session) -> None:
 # -- Repo review --
 
 
+@nox.session
+def readme(session: nox.Session) -> None:
+ """
+ Update the readme with cog. Pass --check to check instead.
+ """
+
+ args = session.posargs or ["-r"]
+
+ session.install("-e.", "cogapp")
+ session.install("git+https://github.com/scientific-python/repo-review")
+ session.run("cog", "-P", *args, "README.md")
+
+
 @nox.session(reuse_venv=True)
 def rr_run(session: nox.Session) -> None:
  """
  Run sp-repo-review.
  """
 
- session.install("-e", ".[cli]")
+ session.install("-e.[cli]")
  session.run("python", "-m", "repo_review", *session.posargs)