repo-review 0.11.1__tar.gz → 0.11.3__tar.gz

{repo_review-0.11.1 → repo_review-0.11.3}/.github/CONTRIBUTING.md

@@ -32,23 +32,17 @@ $ hatch run example:repo-review <args> # Run an example
 Hatch handles everything for you, including setting up an temporary virtual
 environment.
 
+Using `uv run` directly is also supported.
+
 ## Setting up a development environment manually
 
-You can set up a development environment by running:
+You can set up a development environment in `.venv` by running:
 
 ```bash
-python3 -m venv .venv
-source ./.venv/bin/activate
-pip install -v -e .[dev]
+uv sync
 ```
 
-If you have the [Python Launcher for Unix](https://github.com/brettcannon/python-launcher),
-you can instead do:
-
-```bash
-py -m venv .venv
-py -m install -v -e .[dev]
-```
+Or just prefix every command by `uv run`.
 
 # Post setup
 

{repo_review-0.11.1 → repo_review-0.11.3}/.github/workflows/ci.yml

@@ -112,4 +112,4 @@ jobs:
       - name: Run repo-review action
         uses: ./
         with:
-          plugins: sp-repo-review==2024.04.23
+          plugins: sp-repo-review==2024.08.19

{repo_review-0.11.1 → repo_review-0.11.3}/.pre-commit-config.yaml

@@ -5,26 +5,26 @@ ci:
 
 repos:
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.18.0
+    rev: 1.19.1
     hooks:
       - id: blacken-docs
-        additional_dependencies: [black==23.*]
+        additional_dependencies: [black==24.*]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.6.1"
+    rev: "v0.8.3"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 
   - repo: https://github.com/rbubley/mirrors-prettier
-    rev: "v3.3.3"
+    rev: "v3.4.2"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -45,7 +45,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.1
+    rev: v1.13.0
     hooks:
       - id: mypy
         files: (src|web|tests)
@@ -53,6 +53,7 @@ repos:
         additional_dependencies:
           - click>=8.1.5
           - markdown-it-py
+          - orjson
           - pytest
           - rich
           - tomli
@@ -78,12 +79,12 @@ repos:
         exclude: .pre-commit-config.yaml
 
   - repo: https://github.com/henryiii/validate-pyproject-schema-store
-    rev: 2024.08.19
+    rev: 2024.11.25
     hooks:
       - id: validate-pyproject
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.29.1
+    rev: 0.30.0
     hooks:
       - id: check-dependabot
       - id: check-github-workflows

{repo_review-0.11.1 → repo_review-0.11.3}/.readthedocs.yaml

@@ -13,6 +13,4 @@ build:
     - asdf plugin add uv
     - asdf install uv latest
     - asdf global uv latest
-    - uv venv
-    - uv pip install .[docs]
-    - . .venv/bin/activate && sphinx-build -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
+    - uv run --group docs sphinx-build -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html

{repo_review-0.11.1 → repo_review-0.11.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: repo_review
-Version: 0.11.1
+Version: 0.11.3
 Summary: Framework that can run checks on repos
 Project-URL: Changelog, https://github.com/scientific-python/repo-review/releases
 Project-URL: Demo, https://scientific-python.github.io/repo-review
@@ -8,7 +8,6 @@ Project-URL: Documentation, https://repo-review.readthedocs.io
 Project-URL: Homepage, https://repo-review.readthedocs.io
 Project-URL: Source, https://github.com/scientific-python/repo-review
 Author-email: Henry Schreiner <henryfs@princeton.edu>
-License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Environment :: WebAssembly :: Emscripten
@@ -34,29 +33,6 @@ Provides-Extra: cli
 Requires-Dist: click>=8; extra == 'cli'
 Requires-Dist: rich-click; extra == 'cli'
 Requires-Dist: rich>=12.2; extra == 'cli'
-Provides-Extra: dev
-Requires-Dist: click>=8; extra == 'dev'
-Requires-Dist: pytest>=7; extra == 'dev'
-Requires-Dist: rich-click; extra == 'dev'
-Requires-Dist: rich>=12.2; extra == 'dev'
-Requires-Dist: sp-repo-review>=2024.04.23; extra == 'dev'
-Requires-Dist: validate-pyproject>=0.14; extra == 'dev'
-Provides-Extra: docs
-Requires-Dist: click>=8; extra == 'docs'
-Requires-Dist: furo; extra == 'docs'
-Requires-Dist: myst-parser>=0.13; extra == 'docs'
-Requires-Dist: rich-click; extra == 'docs'
-Requires-Dist: rich>=12.2; extra == 'docs'
-Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
-Requires-Dist: sphinx-copybutton; extra == 'docs'
-Requires-Dist: sphinx-github-changelog; extra == 'docs'
-Requires-Dist: sphinx>=4.0; extra == 'docs'
-Requires-Dist: sphinxcontrib-programoutput; extra == 'docs'
-Requires-Dist: sphinxext-opengraph; extra == 'docs'
-Provides-Extra: test
-Requires-Dist: pytest>=7; extra == 'test'
-Requires-Dist: sp-repo-review>=2024.04.23; extra == 'test'
-Requires-Dist: validate-pyproject>=0.14; extra == 'test'
 Description-Content-Type: text/markdown
 
 # repo-review
@@ -159,7 +135,7 @@ webapp. It also would allow `zipfile.Path` to work just as well, too - no need
 to extract.
 
 [Checks][] can request [fixtures][] (like [pytest][]) as arguments. Check files
-can add new fixtures as needed. Fixtures are are specified with entry points,
+can add new fixtures as needed. Fixtures are specified with entry points,
 and take any other fixture as arguments as well - the `root` and `package`
 fixtures represents the root of the repository and of the package you are
 checking, respectively, and are the basis for the other fixtures, which are
@@ -195,7 +171,7 @@ collection functions, the family entry-point also supports fixtures.
 This project inspired [Try-PyHF](https://kratsg.github.io/try-pyhf/), an
 interface for a High Energy Physics package in Scikit-HEP.
 
-This project inspired [abSENSE](https://princetonuniversity.github.io/abSENSE/), an
+This project inspired [abSENSE](https://princetonuniversity.github.io/abSENSE/), a
 web interface to abSENSE.
 
 This was developed for [Scikit-HEP][] before moving to Scientific-Python.

{repo_review-0.11.1 → repo_review-0.11.3}/README.md

@@ -98,7 +98,7 @@ webapp. It also would allow `zipfile.Path` to work just as well, too - no need
 to extract.
 
 [Checks][] can request [fixtures][] (like [pytest][]) as arguments. Check files
-can add new fixtures as needed. Fixtures are are specified with entry points,
+can add new fixtures as needed. Fixtures are specified with entry points,
 and take any other fixture as arguments as well - the `root` and `package`
 fixtures represents the root of the repository and of the package you are
 checking, respectively, and are the basis for the other fixtures, which are
@@ -134,7 +134,7 @@ collection functions, the family entry-point also supports fixtures.
 This project inspired [Try-PyHF](https://kratsg.github.io/try-pyhf/), an
 interface for a High Energy Physics package in Scikit-HEP.
 
-This project inspired [abSENSE](https://princetonuniversity.github.io/abSENSE/), an
+This project inspired [abSENSE](https://princetonuniversity.github.io/abSENSE/), a
 web interface to abSENSE.
 
 This was developed for [Scikit-HEP][] before moving to Scientific-Python.

{repo_review-0.11.1 → repo_review-0.11.3}/docs/checks.md

@@ -30,7 +30,7 @@ explanation instead of the `check()` docstring, you can return a non-empty
 string from the check instead of `False`. Returning `None` makes a check
 "skipped". Docstrings/error messages can access their own object with `{self}`
 and check name with `{name}` (these are processed with `.format()`, so escape `{}`
-as `{{}}`). The error message is in markdown format.
+as `{{}}`). The error message is in Markdown format.
 
 ```{versionchanged} 0.9
 The string return value is not processed via `.format`. You can use `self` and

{repo_review-0.11.1 → repo_review-0.11.3}/docs/cli.md

@@ -17,7 +17,7 @@ pass `--package-dir <path>`.
 
 There are four output formats; `rich` produces great terminal output, `svg`
 produces an SVG based on the rich output, `html` produces a custom HTML report,
-and `json` produces a output that can be processed easily. To make it easier to
+and `json` produces an output that can be processed easily. To make it easier to
 support tools like GitHub Actions, there is also a `--stderr FORMAT` output
 option that produces the selected format on stderr as well, and disables
 producing terminal escape codes on stdout, even if `FORCE_COLOR` is set. This

{repo_review-0.11.1 → repo_review-0.11.3}/docs/families.md

@@ -15,7 +15,7 @@ class Family(typing.TypedDict, total=False):
 
 The `name` will be shown instead if given. The families will be sorted by
 `order` then key. And a `description` will be shown after the name if provided;
-it is expected to be in markdown format.
+it is expected to be in Markdown format.
 
 ```{versionadded} 0.9
 Descriptions are now supported.
@@ -24,7 +24,7 @@ Descriptions are now supported.
 Then you can provide a function that maps family strings to this extra information:
 
 ```python
-def get_familes() -> dict[str, Family]:
+def get_families() -> dict[str, Family]:
     return {
         "general": Family(
             name="General",

{repo_review-0.11.1 → repo_review-0.11.3}/docs/index.html

@@ -65,7 +65,7 @@
           header={true}
           deps={[
             "repo-review~=0.11.0",
-            "sp-repo-review==2024.04.23",
+            "sp-repo-review==2024.08.19",
             "validate-pyproject-schema-store== 2024.08.19",
             "validate-pyproject[all]~=0.19.0",
           ]}

{repo_review-0.11.1 → repo_review-0.11.3}/docs/intro.md

@@ -15,7 +15,7 @@ to use it is:
 pipx run <plugin-name>[cli] .
 ```
 
-This uses [pipx][] (pip for executables) to download the plugin and all of it's
+This uses [pipx][] (pip for executables) to download the plugin and all of its
 dependencies (including repo-review itself) into a temporary virtual
 environment (cached for a week), then runs it. For example:
 

{repo_review-0.11.1 → repo_review-0.11.3}/pyproject.toml

@@ -37,19 +37,40 @@ dependencies = [
   "typing-extensions; python_version < '3.11'",
 ]
 
+[project.urls]
+Changelog = "https://github.com/scientific-python/repo-review/releases"
+Demo = "https://scientific-python.github.io/repo-review"
+Documentation = "https://repo-review.readthedocs.io"
+Homepage = "https://repo-review.readthedocs.io"
+Source = "https://github.com/scientific-python/repo-review"
+
+[project.scripts]
+repo-review = "repo_review.__main__:main"
+
+[project.entry-points."repo_review.fixtures"]
+pyproject = "repo_review.fixtures:pyproject"
+list_all = "repo_review.fixtures:list_all"
+
+[project.entry-points."validate_pyproject.tool_schema"]
+repo-review = "repo_review.schema:get_schema"
+
 [project.optional-dependencies]
 cli = [
   "click >=8",
   "rich >=12.2",
   "rich-click",
 ]
+
+[dependency-groups]
 test = [
   "pytest >=7",
-  "sp-repo-review >=2024.04.23",
+  "sp-repo-review >=2024.08.19",
   "validate-pyproject >=0.14",
 ]
 dev = [
-  "repo-review[test,cli]",
+  { include-group = "test" },
+  "sp-repo-review[cli]",
+  "validate-pyproject-schema-store[all]",
 ]
 docs = [
   "furo",
@@ -63,24 +84,6 @@ docs = [
   "sphinx-github-changelog",
 ]
 
-[project.urls]
-Changelog = "https://github.com/scientific-python/repo-review/releases"
-Demo = "https://scientific-python.github.io/repo-review"
-Documentation = "https://repo-review.readthedocs.io"
-Homepage = "https://repo-review.readthedocs.io"
-Source = "https://github.com/scientific-python/repo-review"
-
-[project.scripts]
-repo-review = "repo_review.__main__:main"
-
-[project.entry-points."repo_review.fixtures"]
-pyproject = "repo_review.fixtures:pyproject"
-list_all = "repo_review.fixtures:list_all"
-
-[project.entry-points."validate_pyproject.tool_schema"]
-repo-review = "repo_review.schema:get_schema"
-
-
 [tool.hatch]
 version.source = "vcs"
 build.hooks.vcs.version-file = "src/repo_review/_version.py"
@@ -89,7 +92,13 @@ build.hooks.vcs.version-file = "src/repo_review/_version.py"
 installer = "uv"
 
 [tool.hatch.envs.hatch-test]
-features = ["test", "cli"]
+features = ["cli"]
+# duplicated since hatch doesn't support groups yet
+dependencies = [
+  "pytest >=7",
+  "sp-repo-review >=2024.08.19",
+  "validate-pyproject >=0.14",
+]
 env-vars.PYTHONWARNDEFAULTENCODING = "1"
 
 [tool.hatch.envs.lint]
@@ -103,8 +112,19 @@ dependencies = ["pylint>=3.2"]
 scripts.lint = "pylint repo_review {args}"
 
 [tool.hatch.envs.docs]
-features = ["docs"]
-dependencies = ["sphinx-autobuild"]
+# duplicated since hatch doesn't support groups yet
+dependencies = [
+  "furo",
+  "myst_parser >=0.13",
+  "repo-review[cli]",
+  "sphinx >=4.0",
+  "sphinx-autodoc-typehints",
+  "sphinx-copybutton",
+  "sphinxcontrib-programoutput",
+  "sphinxext-opengraph",
+  "sphinx-github-changelog",
+  "sphinx-autobuild",
+]
 scripts.linkcheck = "sphinx-build -b=linkcheck docs docs/_build/linkcheck {args}"
 scripts.html = "sphinx-build --keep-going -n -T -b=html docs docs/_build/html {args}"
 scripts.serve = "sphinx-autobuild -n -T -b=html docs docs/_build/html {args}"
@@ -204,7 +224,6 @@ extend-select = [
 ]
 ignore = [
   "ISC001",  # May collide with formatter
-  "PT004",   # Incorrect check, usefixtures is the correct way to do this
   "PLR09",   # Too many X
   "PLR2004", # Magic value in comparison
 ]
@@ -223,6 +242,3 @@ typing-modules = ["repo_review._compat.typing"]
 [tool.ruff.lint.per-file-ignores]
 "src/repo_review/_compat/**.py" = ["TID251"]
 "src/**/__main__.py" = ["T20"]
-
-[tool.repo-review]
-ignore = ["RF003", "PC180"]  # Will be fixed in next sp-repo-review release

{repo_review-0.11.1 → repo_review-0.11.3}/src/repo_review/__main__.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import importlib.metadata
 import itertools
 import json
 import os
@@ -33,9 +34,9 @@ from .ghpath import GHPath
 from .html import to_html
 from .processor import Result, as_simple_dict, collect_all, process
 
-__all__ = ["main", "Formats", "Show", "Status"]
+__all__ = ["Formats", "Show", "Status", "main"]
 
-CODE_THEME = "default"
+CODE_THEME = "ansi_light"
 
 
 def __dir__() -> list[str]:
@@ -74,6 +75,29 @@ def list_all(ctx: click.Context, _param: click.Parameter, value: bool) -> None:
     ctx.exit()
 
 
+def all_versions(ctx: click.Context, _param: click.Parameter, value: bool) -> None:
+    if not value or ctx.resilient_parsing:
+        return
+
+    groups = ["repo_review.checks", "repo_review.families", "repo_review.fixtures"]
+    packages = {
+        dist.name: dist.version
+        for group in groups
+        for ep in importlib.metadata.entry_points(group=group)
+        if (dist := ep.dist) is not None
+    }
+    deps = ["rich", "rich-click", "click", "markdown-it-py", "pyyaml"]
+    rich.print("Repo-review's dependencies:")
+    for name in deps:
+        rich.print(
+            f"  [bold]{name}[/bold]: [magenta]{importlib.metadata.version(name)}[/magenta]"
+        )
+    rich.print("Packages providing repo-review plugins:")
+    for name, version in sorted(packages.items()):
+        rich.print(f"  [bold]{name}[/bold]: [green]{version}[/green]")
+    ctx.exit()
+
+
 def rich_printer(
     families: Mapping[str, Family],
     processed: list[Result],
@@ -243,9 +267,25 @@ def _remote_path_processor(package: Path) -> Path | GHPath:
     "packages",
     type=click.Path(dir_okay=True, path_type=Path),
     nargs=-1,
-    required=True,
+    required=False,
     callback=remote_path_support,
 )
+@click.option(
+    "--versions",
+    is_flag=True,
+    callback=all_versions,
+    expose_value=False,
+    is_eager=True,
+    help="List all plugin versions and exit",
+)
+@click.option(
+    "--list-all",
+    is_flag=True,
+    callback=list_all,
+    expose_value=False,
+    is_eager=True,
+    help="List all checks and exit",
+)
 @click.option(
     "--format",
     "format_opt",
@@ -259,6 +299,12 @@ def _remote_path_processor(package: Path) -> Path | GHPath:
     type=click.Choice(["rich", "json", "html", "svg"]),
     help="Select additional output format for stderr. Will disable terminal escape codes for stdout for easy redirection.",
 )
+@click.option(
+    "--show",
+    type=click.Choice(["all", "err", "errskip"]),
+    default="all",
+    help="Show all (default), or just errors, or errors and skips",
+)
 @click.option(
     "--select",
     help="Only run certain checks, comma separated. All checks run if empty.",
@@ -275,20 +321,6 @@ def _remote_path_processor(package: Path) -> Path | GHPath:
     help="Path to python package.",
     default="",
 )
-@click.option(
-    "--list-all",
-    is_flag=True,
-    callback=list_all,
-    expose_value=False,
-    is_eager=True,
-    help="List all checks and exit",
-)
-@click.option(
-    "--show",
-    type=click.Choice(["all", "err", "errskip"]),
-    default="all",
-    help="Show all (default), or just errors, or errors and skips",
-)
 def main(
     packages: list[Path | GHPath],
     format_opt: Formats,
@@ -299,8 +331,11 @@ def main(
     show: Show,
 ) -> None:
     """
-    Pass in a local Path or gh:org/repo@branch.
+    Pass in a local Path or gh:org/repo@branch. Will run on the current
+    directory if no path passed.
     """
+    if not packages:
+        packages = [Path()]
 
     if len(packages) > 1:
         if format_opt == "json":

{repo_review-0.11.1 → repo_review-0.11.3}/src/repo_review/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.11.1'
-__version_tuple__ = version_tuple = (0, 11, 1)
+__version__ = version = '0.11.3'
+__version_tuple__ = version_tuple = (0, 11, 3)

{repo_review-0.11.1 → repo_review-0.11.3}/src/repo_review/checks.py

@@ -6,7 +6,7 @@ from typing import Any, Protocol
 
 from .fixtures import apply_fixtures
 
-__all__ = ["Check", "collect_checks", "is_allowed", "get_check_url"]
+__all__ = ["Check", "collect_checks", "get_check_url", "is_allowed"]
 
 
 def __dir__() -> list[str]:

{repo_review-0.11.1 → repo_review-0.11.3}/src/repo_review/fixtures.py

@@ -12,11 +12,11 @@ from ._compat.importlib.resources.abc import Traversable
 from .ghpath import EmptyTraversable
 
 __all__ = [
-    "pyproject",
-    "list_all",
-    "compute_fixtures",
     "apply_fixtures",
     "collect_fixtures",
+    "compute_fixtures",
+    "list_all",
+    "pyproject",
 ]
 
 
@@ -36,8 +36,7 @@ def pyproject(package: Traversable) -> dict[str, Any]:
     pyproject_path = package.joinpath("pyproject.toml")
     if pyproject_path.is_file():
         with pyproject_path.open("rb") as f:
-            # Type ignore fixed in https://github.com/hukkin/tomli/pull/215
-            return tomllib.load(f)  # type: ignore[arg-type]
+            return tomllib.load(f)
     return {}
 
 

{repo_review-0.11.1 → repo_review-0.11.3}/src/repo_review/ghpath.py

@@ -14,7 +14,7 @@ from typing import Literal
 
 from ._compat.importlib.resources.abc import Traversable
 
-__all__ = ["GHPath", "EmptyTraversable"]
+__all__ = ["EmptyTraversable", "GHPath"]
 
 
 def __dir__() -> list[str]:

{repo_review-0.11.1 → repo_review-0.11.3}/src/repo_review/processor.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
 
+import copy
 import dataclasses
 import graphlib
 import textwrap
 import typing
+import warnings
 from collections.abc import Mapping, Set
 from typing import Any, TypeVar
 
@@ -28,8 +30,8 @@ __all__ = [
     "ResultDict",
     "as_simple_dict",
     "collect_all",
-    "process",
     "md_as_html",
+    "process",
 ]
 
 
@@ -211,13 +213,18 @@ def process(
 
     # Keep track of which checks have been completed
     completed: dict[str, str | None] = {}
+    fixtures_copy = copy.deepcopy(fixtures)
 
     # Run all the checks in topological order based on their dependencies
     ts = graphlib.TopologicalSorter(graph)
     for name in ts.static_order():
         if all(completed.get(n, "") == "" for n in graph[name]):
-            result = apply_fixtures({"name": name, **fixtures}, tasks[name].check)
+            result = apply_fixtures({"name": name, **fixtures_copy}, tasks[name].check)
             completed[name] = process_result_bool(result, tasks[name], name)
+            if fixtures != fixtures_copy:
+                fixtures_copy = copy.deepcopy(fixtures)
+                msg = f"{name} modified the input fixtures! Making a deepcopy to fix and continue."
+                warnings.warn(msg, stacklevel=1)
         else:
             completed[name] = None
 

{repo_review-0.11.1 → repo_review-0.11.3}/src/repo_review/testing.py

@@ -13,7 +13,7 @@ from .checks import Check, get_check_url, process_result_bool
 from .fixtures import apply_fixtures
 from .processor import Result
 
-__all__ = ["toml_loads", "compute_check"]
+__all__ = ["compute_check", "toml_loads"]
 
 
 def __dir__() -> list[str]:

{repo_review-0.11.1 → repo_review-0.11.3}/tests/test_self.py

@@ -6,7 +6,7 @@ import repo_review.processor
 
 
 @pytest.fixture(autouse=True)
-def patch_entry_points(local_entry_points: object) -> None:  # noqa: ARG001
+def patch_entry_points(local_entry_points: object) -> None:
     pass