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

{repo_review-0.11.0 → repo_review-0.11.1}/.devcontainer/devcontainer.json

@@ -1,6 +1,6 @@
 {
   "name": "repo-review[dev]",
-  "image": "mcr.microsoft.com/devcontainers/python:0-3.11",
+  "image": "mcr.microsoft.com/devcontainers/python:0-3.12",
   "postCreateCommand": "pipx install hatch && pip install -e.[cli,test] pylint",
   "customizations": {
     "vscode": {

repo_review-0.11.1/.github/release.yml

@@ -0,0 +1,5 @@
+changelog:
+  exclude:
+    authors:
+      - dependabot
+      - pre-commit-ci

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

@@ -27,12 +27,8 @@ jobs:
         with:
           python-version: "3.x"
       - uses: pre-commit/action@v3.0.1
-        with:
-          extra_args: --hook-stage manual --all-files
       - name: Run PyLint
-        run: |
-          echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"
-          pipx run --python=python hatch run pylint:lint
+        run: pipx run --python=python hatch run pylint:lint --output-format=github
 
   checks:
     name: Check Python on ${{ matrix.runs-on }}
@@ -53,6 +49,8 @@ jobs:
             3.10
             3.11
             3.12
+            3.13
+          allow-prereleases: true
 
       - name: Setup uv
         uses: yezz123/setup-uv@v4
@@ -62,8 +60,6 @@ jobs:
 
       - name: Test package (all Pythons)
         run: hatch test -a
-        env:
-          PYTHONUTF8: "1"
 
   dist:
     name: Distribution build

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

@@ -1,23 +1,24 @@
 ci:
   autoupdate_commit_msg: "chore(deps): update pre-commit hooks"
   autofix_commit_msg: "style: pre-commit fixes"
+  autoupdate_schedule: monthly
 
 repos:
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
+    rev: 1.18.0
     hooks:
       - id: blacken-docs
         additional_dependencies: [black==23.*]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.4.2"
+    rev: "v0.6.1"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 
-  - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v4.0.0-alpha.8"
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: "v3.3.3"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
@@ -44,7 +45,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.0
+    rev: v1.11.1
     hooks:
       - id: mypy
         files: (src|web|tests)
@@ -58,7 +59,7 @@ repos:
           - types-PyYAML
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
         args: ["-Lhist,absense", "-w"]
@@ -77,12 +78,12 @@ repos:
         exclude: .pre-commit-config.yaml
 
   - repo: https://github.com/henryiii/validate-pyproject-schema-store
-    rev: 2024.04.29
+    rev: 2024.08.19
     hooks:
       - id: validate-pyproject
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.28.2
+    rev: 0.29.1
     hooks:
       - id: check-dependabot
       - id: check-github-workflows

repo_review-0.11.1/.readthedocs.yaml

@@ -0,0 +1,18 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+  commands:
+    - 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: repo_review
-Version: 0.11.0
+Version: 0.11.1
 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
@@ -21,6 +21,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Typing :: Typed
@@ -38,7 +39,7 @@ 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>=2023.12.21; 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'
@@ -54,7 +55,7 @@ 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>=2023.12.21; 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
 
@@ -76,7 +77,7 @@ least one plugin to be installed.
 With one or more plugins, it 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. Four
-output formats are supported; `rich`, `svg`, `html`, and `json`.
+output formats are supported: `rich`, `svg`, `html`, and `json`.
 
 ## Plugins
 
@@ -140,7 +141,7 @@ the files that interest the plugin in question.
 
 So if you want to lint Python code, use Flake8 or Ruff. But if you want to
 check Flake8 or Ruff's configuration, use repo-review! Generally, repo-review
-plugins are more about requiring things to be present, like making use all your
+plugins are more about requiring things to be present, like making sure all your
 repos have some [pre-commit][] check.
 
 ## Development of repo-review and plugins
@@ -169,7 +170,7 @@ accept fixtures, allowing dynamic check listings.
 Check files do not depend on the main library, and can be extended (similar to
 Flake8). You register new check files via entry-points - so extending this is
 with custom checks or custom fixtures is easy and trivial. There's no need to
-subclass or do anything with the base library - no dependency required.
+subclass or do anything with the base library - no dependency on repo-review required.
 
 Checks are as simple as possible so they are easy to write. A check is a class
 with the name (1-2 letters + number) and a docstring (the check message). It

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

@@ -16,7 +16,7 @@ least one plugin to be installed.
 With one or more plugins, it 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. Four
-output formats are supported; `rich`, `svg`, `html`, and `json`.
+output formats are supported: `rich`, `svg`, `html`, and `json`.
 
 ## Plugins
 
@@ -80,7 +80,7 @@ the files that interest the plugin in question.
 
 So if you want to lint Python code, use Flake8 or Ruff. But if you want to
 check Flake8 or Ruff's configuration, use repo-review! Generally, repo-review
-plugins are more about requiring things to be present, like making use all your
+plugins are more about requiring things to be present, like making sure all your
 repos have some [pre-commit][] check.
 
 ## Development of repo-review and plugins
@@ -109,7 +109,7 @@ accept fixtures, allowing dynamic check listings.
 Check files do not depend on the main library, and can be extended (similar to
 Flake8). You register new check files via entry-points - so extending this is
 with custom checks or custom fixtures is easy and trivial. There's no need to
-subclass or do anything with the base library - no dependency required.
+subclass or do anything with the base library - no dependency on repo-review required.
 
 Checks are as simple as possible so they are easy to write. A check is a class
 with the name (1-2 letters + number) and a docstring (the check message). It

{repo_review-0.11.0 → repo_review-0.11.1}/action.yml

@@ -26,7 +26,7 @@ runs:
     - uses: actions/setup-python@v5
       id: python
       with:
-        python-version: "3.11"
+        python-version: "3.12"
         update-environment: false
 
     - name: Install repo-review and plugins

{repo_review-0.11.0 → repo_review-0.11.1}/docs/conf.py

@@ -1,8 +1,11 @@
+from __future__ import annotations
+
 import importlib
 import importlib.metadata
 import inspect
 import os
 from pathlib import Path
+from typing import Any
 
 import repo_review
 
@@ -39,6 +42,24 @@ exclude_patterns = [
 
 html_theme = "furo"
 
+html_theme_options: dict[str, Any] = {
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/scientific-python/repo-review",
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
+    "source_repository": "https://github.com/scientific-python/repo-review/",
+    "source_branch": "main",
+    "source_directory": "docs/",
+}
+
 myst_enable_extensions = [
     "colon_fence",
     "deflist",

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

@@ -6,7 +6,7 @@
       content="initial-scale=1, width=device-width"
     />
     <script
-      src="https://cdn.jsdelivr.net/pyodide/v0.25.1/full/pyodide.js"
+      src="https://cdn.jsdelivr.net/pyodide/v0.26.2/full/pyodide.js"
       crossorigin
     ></script>
     <!-- Production -->
@@ -19,7 +19,7 @@
       crossorigin
     ></script>
     <script
-      src="https://unpkg.com/@mui/material@v5.15.16/umd/material-ui.production.min.js"
+      src="https://unpkg.com/@mui/material@v5.16.7/umd/material-ui.production.min.js"
       crossorigin
     ></script>
     <!-- Development
@@ -32,7 +32,7 @@
       crossorigin
     ></script>
     <script
-      src="https://unpkg.com/@mui/material@v5.15.16/umd/material-ui.development.js"
+      src="https://unpkg.com/@mui/material@v5.16.7/umd/material-ui.development.js"
       crossorigin
     ></script>
     -->
@@ -64,10 +64,10 @@
         <App
           header={true}
           deps={[
-            "repo-review~=0.10.0",
+            "repo-review~=0.11.0",
             "sp-repo-review==2024.04.23",
-            "validate-pyproject-schema-store==2024.04.20",
-            "validate-pyproject[all]~=0.16.0",
+            "validate-pyproject-schema-store== 2024.08.19",
+            "validate-pyproject[all]~=0.19.0",
           ]}
         />,
       );

{repo_review-0.11.0 → repo_review-0.11.1}/docs/plugins.md

@@ -43,7 +43,7 @@ def test_has_tool_ruff(tmp_path: Path) -> None:
     # In this example, tool.ruff is required to be present by this plugin
     d = tmp_path / "some_package"
     d.mkdir()
-    d.joinpath("pyproject.toml").write_text("[tool.ruff]")
+    d.joinpath("pyproject.toml").write_text("[tool.ruff]", encoding="utf-8")
     processed = repo_review_processor.process(d)
     assert all(r.result for r in processed.results), f"{processed.results}"
 ```

{repo_review-0.11.0 → repo_review-0.11.1}/docs/webapp.md

@@ -20,7 +20,7 @@ You can also use the `html` output and write your own webapp. You need to provid
 
 ```html
 <script
-  src="https://cdn.jsdelivr.net/pyodide/v0.23.2/full/pyodide.js"
+  src="https://cdn.jsdelivr.net/pyodide/v0.25.1/full/pyodide.js"
   crossorigin
 ></script>
 ```
@@ -44,13 +44,10 @@ You can get the families and the checks:
 
 ```js
 result_html_py = pyodide.runPython(`
-  from pyodide.http import open_url
   from repo_review.processor import process
   from repo_review.ghpath import GHPath
   from repo_review.html import to_html
 
-  GHPath.open_url = staticmethod(open_url)
-
   package = GHPath(repo="${state.repo}", branch="${state.branch}")
   to_html(*process(package))
 `);

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

@@ -23,6 +23,7 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python",
   "Topic :: Software Development :: Quality Assurance",
   "Topic :: Software Development :: Libraries :: Python Modules",
@@ -44,7 +45,7 @@ cli = [
 ]
 test = [
   "pytest >=7",
-  "sp-repo-review >=2023.12.21",
+  "sp-repo-review >=2024.04.23",
   "validate-pyproject >=0.14",
 ]
 dev = [
@@ -89,6 +90,7 @@ installer = "uv"
 
 [tool.hatch.envs.hatch-test]
 features = ["test", "cli"]
+env-vars.PYTHONWARNDEFAULTENCODING = "1"
 
 [tool.hatch.envs.lint]
 dependencies = ["pre-commit"]
@@ -97,7 +99,7 @@ scripts.lint = "pre-commit run --all-files --show-diff-on-failure {args}"
 
 [tool.hatch.envs.pylint]
 features = ["cli"]
-dependencies = ["pylint"]
+dependencies = ["pylint>=3.2"]
 scripts.lint = "pylint repo_review {args}"
 
 [tool.hatch.envs.docs]
@@ -122,7 +124,7 @@ skip-install = true
 scripts.serve = "cd docs && echo 'Serving on http://localhost:8080' && python -m http.server 8080"
 
 [[tool.hatch.envs.hatch-test.matrix]]
-python = ["3.12", "3.11", "3.10"]
+python = ["3.13", "3.12", "3.11", "3.10"]
 
 
 [tool.pytest.ini_options]
@@ -178,9 +180,6 @@ messages_control.disable = [
 ]
 
 
-[tool.ruff]
-src = ["src"]
-
 [tool.ruff.lint]
 extend-select = [
   "B",           # flake8-bugbear
@@ -225,6 +224,5 @@ typing-modules = ["repo_review._compat.typing"]
 "src/repo_review/_compat/**.py" = ["TID251"]
 "src/**/__main__.py" = ["T20"]
 
-
 [tool.repo-review]
-ignore = ["PC110"]
+ignore = ["RF003", "PC180"]  # Will be fixed in next sp-repo-review release

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

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import itertools
 import json
+import os
 import sys
 import typing
 from collections.abc import Mapping, Sequence
@@ -83,6 +84,17 @@ def rich_printer(
     status: Status,
     header: str = "",
 ) -> None:
+    # Before Python 3.15, this isn't always unicode
+    if (
+        sys.version_info < (3, 15)
+        and "PYTHONIOENCODING" not in os.environ
+        and "PYTHONUTF8" not in os.environ
+    ):
+        if sys.stdout.encoding != "utf-8":
+            sys.stdout.reconfigure(encoding="utf-8")  # type: ignore[union-attr]
+        if sys.stderr.encoding != "utf-8":
+            sys.stderr.reconfigure(encoding="utf-8")  # type: ignore[union-attr]
+
     console = rich.console.Console(
         record=svg, quiet=svg, stderr=stderr, color_system="auto" if color else None
     )

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

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

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

@@ -89,9 +89,8 @@ def is_allowed(select: Set[str], ignore: Set[str], name: str) -> bool:
         and "*" not in select
     ):
         return False
-    if name in ignore or name.rstrip("0123456789") in ignore:
-        return False
-    return True
+
+    return name not in ignore and name.rstrip("0123456789") not in ignore
 
 
 def get_check_url(name: str, check: Check) -> str:

{repo_review-0.11.0 → repo_review-0.11.1}/src/repo_review/resources/repo-review.schema.json

@@ -9,7 +9,18 @@
       "$ref": "#/$defs/checks"
     },
     "ignore": {
-      "$ref": "#/$defs/checks"
+      "oneOf": [
+        {
+          "$ref": "#/$defs/checks"
+        },
+        {
+          "type": "object",
+          "patternProperties": {
+            "^[A-Z]+[0-9]*$": { "type": "string" }
+          },
+          "additionalProperties": false
+        }
+      ]
     }
   },
   "$defs": {

{repo_review-0.11.0 → repo_review-0.11.1}/tests/conftest.py

@@ -9,7 +9,7 @@ def nocolor(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.delenv("FORCE_COLOR", raising=False)
 
 
-@pytest.fixture()
+@pytest.fixture
 def no_entry_points(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr(
         importlib.metadata,
@@ -18,7 +18,7 @@ def no_entry_points(monkeypatch: pytest.MonkeyPatch) -> None:
     )
 
 
-@pytest.fixture()
+@pytest.fixture
 def local_entry_points(monkeypatch: pytest.MonkeyPatch) -> None:
     orig_ep = importlib.metadata.entry_points
     ep1 = importlib.metadata.EntryPoint(

{repo_review-0.11.0 → repo_review-0.11.1}/tests/test_multi.py

@@ -10,7 +10,7 @@ from click.testing import CliRunner
 from repo_review.__main__ import main
 
 
-@pytest.fixture()
+@pytest.fixture
 def multiple_packages(tmp_path: Path) -> tuple[str, str]:
     packages = (tmp_path / "package_1", tmp_path / "package_2")
 
@@ -28,7 +28,7 @@ def multiple_packages(tmp_path: Path) -> tuple[str, str]:
             """
         )
 
-        package.joinpath("pyproject.toml").write_text(basic_toml)
+        package.joinpath("pyproject.toml").write_text(basic_toml, encoding="utf-8")
         package.joinpath(".pre-commit-config.yaml").touch()
         package.joinpath("README.md").touch()
 

{repo_review-0.11.0 → repo_review-0.11.1}/tests/test_package.py

@@ -36,16 +36,54 @@ def test_broken_validate_pyproject(tmp_path: Path) -> None:
                 [tool.repo-review]
                 ignore = ["a2"]
             """
-        )
+        ),
+        encoding="utf-8",
     )
 
     results = process(tmp_path)
 
     (result,) = (r for r in results.results if r.name == "VPP001")
-    assert "must match pattern" in result.err_msg
+    assert "must be valid exactly by one definition" in result.err_msg
     assert not result.result
 
 
+def test_broken_validate_pyproject_object(tmp_path: Path) -> None:
+    pytest.importorskip("validate_pyproject")
+    tmp_path.joinpath("pyproject.toml").write_text(
+        textwrap.dedent(
+            """\
+                [tool.repo-review.ignore]
+                a2 = "some message"
+            """
+        ),
+        encoding="utf-8",
+    )
+
+    results = process(tmp_path)
+
+    (result,) = (r for r in results.results if r.name == "VPP001")
+    assert "must be valid exactly by one definition" in result.err_msg
+    assert not result.result
+
+
+def test_working_validate_pyproject_object(tmp_path: Path) -> None:
+    pytest.importorskip("validate_pyproject")
+    tmp_path.joinpath("pyproject.toml").write_text(
+        textwrap.dedent(
+            """\
+                [tool.repo-review.ignore]
+                PP102 = "some message"
+            """
+        ),
+        encoding="utf-8",
+    )
+
+    results = process(tmp_path)
+
+    (result,) = (r for r in results.results if r.name == "VPP001")
+    assert result.result
+
+
 def test_testing_function():
     pytest.importorskip("sp_repo_review")
 

{repo_review-0.11.0 → repo_review-0.11.1}/tests/test_utilities/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "pyproject"
 version = "0.0.1"
-classfiers = [
+classifiers = [
     "Private :: Do Not Upload",
 ]
 description = "Simple repo-review example for testing"

repo_review-0.11.0/.github/matchers/pylint.json

@@ -1,32 +0,0 @@
-{
-  "problemMatcher": [
-    {
-      "severity": "warning",
-      "pattern": [
-        {
-          "regexp": "^([^:]+):(\\d+):(\\d+): ([A-DF-Z]\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
-          "file": 1,
-          "line": 2,
-          "column": 3,
-          "code": 4,
-          "message": 5
-        }
-      ],
-      "owner": "pylint-warning"
-    },
-    {
-      "severity": "error",
-      "pattern": [
-        {
-          "regexp": "^([^:]+):(\\d+):(\\d+): (E\\d+): \\033\\[[\\d;]+m([^\\033]+).*$",
-          "file": 1,
-          "line": 2,
-          "column": 3,
-          "code": 4,
-          "message": 5
-        }
-      ],
-      "owner": "pylint-error"
-    }
-  ]
-}

repo_review-0.11.0/.readthedocs.yaml

@@ -1,22 +0,0 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-build:
-  os: "ubuntu-22.04"
-  tools:
-    python: "3.11"
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs