repo-review 0.9.2__tar.gz → 0.9.3__tar.gz

{repo_review-0.9.2 → repo_review-0.9.3}/.pre-commit-config.yaml

@@ -3,25 +3,25 @@ ci:
   autofix_commit_msg: "style: pre-commit fixes"
 
 repos:
-  - repo: https://github.com/psf/black
+  - repo: https://github.com/psf/black-pre-commit-mirror
     rev: 23.7.0
     hooks:
       - id: black-jupyter
 
-  - repo: https://github.com/asottile/blacken-docs
-    rev: 1.15.0
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.16.0
     hooks:
       - id: blacken-docs
         additional_dependencies: [black==23.7.0]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.0.281"
+    rev: "v0.0.285"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.0.0"
+    rev: "v3.0.2"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
@@ -48,7 +48,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.4.1
+    rev: v1.5.1
     hooks:
       - id: mypy
         files: (src|web|tests)

{repo_review-0.9.2 → repo_review-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: repo_review
-Version: 0.9.2
+Version: 0.9.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
@@ -47,7 +47,8 @@ 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; extra == 'test'
+Requires-Dist: sp-repo-review>=2023.08.23; extra == 'test'
+Requires-Dist: validate-pyproject>=0.14; extra == 'test'
 Description-Content-Type: text/markdown
 
 # repo-review
@@ -71,22 +72,25 @@ output formats are supported; `rich`, `svg`, `html`, and `json`.
 
 `sp-repo-review` provides checks based on the
 [Scientific-Python Development Guide][] at [scientific-python/cookie][]. A live
-WebAssembly demo using `sp-repo-review` is
+WebAssembly demo using [sp-repo-review][] is
 [here][repo-review-demo].
 
 ## Running repo-review
 
 Repo-review supports running multiple ways:
 
-- From the command line on a local folder
+- [From the command line][cli] on a local folder
 - From the command line on a remote repository on GitHub (`gh:org/repo@branch`)
-- From WebAssembly in [Pyodide][] (example in `docs/index.html`)
+- [From WebAssembly][webapp] in [Pyodide][] (example in `docs/index.html`)
+- [From pre-commit][intro-pre-commit]
+- [From GitHub Actions][intro-github-actions]
+- [From Python][programmatic-usage]
 
 If the root of a package is not the repository root, pass `--package-dir a/b/c`.
 
 ## Configuration
 
-Repo-review supports configuration via `pyproject.toml`:
+Repo-review [supports configuration][intro-configuring] via `pyproject.toml`:
 
 ```toml
 [tool.repo-review]
@@ -119,7 +123,7 @@ This project is intended to be fun and easy to develop and design checks for -
 it requires and uses Python 3.10, and uses a lot of the new features in 3.9 and
 3.10. It's maybe not entirely conventional, but it enables very simple plugin
 development. It works locally, remotely, and in WebAssembly (using
-[Pyodide][]).
+[Pyodide][]). [See the docs][writing-a-plugin].
 
 There are a few key designs that are very useful and make this possible. First,
 all paths are handled as Traversables. This allows a simple Traversable
@@ -127,13 +131,14 @@ implementation based on `open_url` to provide a web interface for use in the
 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, 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 all other fixtures. `pyproject` is provided
-as well. Checks are specified via an entrypoint that returns a dict of checks;
-this also can accept fixtures, allowing dynamic check listings.
+[Checks][] can request [fixtures][] (like [pytest][]) as arguments. Check files
+can add new fixtures as needed. Fixtures are 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
+topologically sorted and cached. `pyproject` is provided as well. Checks are
+specified via an entrypoint that returns a dict of checks; this can also can
+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
@@ -154,6 +159,17 @@ get a `None` result and the check method will not run. The front-end (Rich
 powered CLI or Pyodide webapp) will render the markdown-formatted check
 docstring only if the result is `False`.
 
+Checks are organized by [Families][]. A plugin can customize the display name,
+change the sort order, and add an optional (dynamic) description. Like the other
+collection functions, the family entry-point also supports fixtures.
+
+## Plugins
+
+Feel free to request your plugin be added to this list.
+
+- [sp-repo-review][]: Checks based on the [Scientific-Python Development Guide][].
+- [validate-pyproject][]: Adds a check to validate pyproject sections, also supports plugins.
+
 ## Links
 
 This project inspired [Try-PyHF](https://kratsg.github.io/try-pyhf/), an
@@ -182,5 +198,21 @@ This was developed for [Scikit-HEP][] before moving to Scientific-Python.
 [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
+[sp-repo-review]: https://pypi.org/project/sp-repo-review
+[validate-pyproject]: https://validate-pyproject.readthedocs.io
+
+[intro-pre-commit]: https://repo-review.readthedocs.io/en/latest/intro.html#pre-commit
+[intro-github-actions]: https://repo-review.readthedocs.io/en/latest/intro.html#github-actions
+[cli]: https://repo-review.readthedocs.io/en/latest/cli.html
+[programmatic-usage]: https://repo-review.readthedocs.io/en/latest/programmatic.html
+[webapp]: https://repo-review.readthedocs.io/en/latest/webapp.html
+[intro-configuring]: https://repo-review.readthedocs.io/en/latest/intro.html#configuring
+[writing-a-plugin]: https://repo-review.readthedocs.io/en/latest/plugins.html
+[fixtures]: https://repo-review.readthedocs.io/en/latest/fixtures.html
+[checks]: https://repo-review.readthedocs.io/en/latest/checks.html
+[families]: https://repo-review.readthedocs.io/en/latest/families.html
+[changelog]: https://repo-review.readthedocs.io/en/latest/changelog.html
+[api]: https://repo-review.readthedocs.io/en/latest/api/repo_review.html
+
 
 <!-- prettier-ignore-end -->

{repo_review-0.9.2 → repo_review-0.9.3}/README.md

@@ -19,22 +19,25 @@ output formats are supported; `rich`, `svg`, `html`, and `json`.
 
 `sp-repo-review` provides checks based on the
 [Scientific-Python Development Guide][] at [scientific-python/cookie][]. A live
-WebAssembly demo using `sp-repo-review` is
+WebAssembly demo using [sp-repo-review][] is
 [here][repo-review-demo].
 
 ## Running repo-review
 
 Repo-review supports running multiple ways:
 
-- From the command line on a local folder
+- [From the command line][cli] on a local folder
 - From the command line on a remote repository on GitHub (`gh:org/repo@branch`)
-- From WebAssembly in [Pyodide][] (example in `docs/index.html`)
+- [From WebAssembly][webapp] in [Pyodide][] (example in `docs/index.html`)
+- [From pre-commit][intro-pre-commit]
+- [From GitHub Actions][intro-github-actions]
+- [From Python][programmatic-usage]
 
 If the root of a package is not the repository root, pass `--package-dir a/b/c`.
 
 ## Configuration
 
-Repo-review supports configuration via `pyproject.toml`:
+Repo-review [supports configuration][intro-configuring] via `pyproject.toml`:
 
 ```toml
 [tool.repo-review]
@@ -67,7 +70,7 @@ This project is intended to be fun and easy to develop and design checks for -
 it requires and uses Python 3.10, and uses a lot of the new features in 3.9 and
 3.10. It's maybe not entirely conventional, but it enables very simple plugin
 development. It works locally, remotely, and in WebAssembly (using
-[Pyodide][]).
+[Pyodide][]). [See the docs][writing-a-plugin].
 
 There are a few key designs that are very useful and make this possible. First,
 all paths are handled as Traversables. This allows a simple Traversable
@@ -75,13 +78,14 @@ implementation based on `open_url` to provide a web interface for use in the
 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, 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 all other fixtures. `pyproject` is provided
-as well. Checks are specified via an entrypoint that returns a dict of checks;
-this also can accept fixtures, allowing dynamic check listings.
+[Checks][] can request [fixtures][] (like [pytest][]) as arguments. Check files
+can add new fixtures as needed. Fixtures are 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
+topologically sorted and cached. `pyproject` is provided as well. Checks are
+specified via an entrypoint that returns a dict of checks; this can also can
+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
@@ -102,6 +106,17 @@ get a `None` result and the check method will not run. The front-end (Rich
 powered CLI or Pyodide webapp) will render the markdown-formatted check
 docstring only if the result is `False`.
 
+Checks are organized by [Families][]. A plugin can customize the display name,
+change the sort order, and add an optional (dynamic) description. Like the other
+collection functions, the family entry-point also supports fixtures.
+
+## Plugins
+
+Feel free to request your plugin be added to this list.
+
+- [sp-repo-review][]: Checks based on the [Scientific-Python Development Guide][].
+- [validate-pyproject][]: Adds a check to validate pyproject sections, also supports plugins.
+
 ## Links
 
 This project inspired [Try-PyHF](https://kratsg.github.io/try-pyhf/), an
@@ -130,5 +145,21 @@ This was developed for [Scikit-HEP][] before moving to Scientific-Python.
 [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
+[sp-repo-review]: https://pypi.org/project/sp-repo-review
+[validate-pyproject]: https://validate-pyproject.readthedocs.io
+
+[intro-pre-commit]: https://repo-review.readthedocs.io/en/latest/intro.html#pre-commit
+[intro-github-actions]: https://repo-review.readthedocs.io/en/latest/intro.html#github-actions
+[cli]: https://repo-review.readthedocs.io/en/latest/cli.html
+[programmatic-usage]: https://repo-review.readthedocs.io/en/latest/programmatic.html
+[webapp]: https://repo-review.readthedocs.io/en/latest/webapp.html
+[intro-configuring]: https://repo-review.readthedocs.io/en/latest/intro.html#configuring
+[writing-a-plugin]: https://repo-review.readthedocs.io/en/latest/plugins.html
+[fixtures]: https://repo-review.readthedocs.io/en/latest/fixtures.html
+[checks]: https://repo-review.readthedocs.io/en/latest/checks.html
+[families]: https://repo-review.readthedocs.io/en/latest/families.html
+[changelog]: https://repo-review.readthedocs.io/en/latest/changelog.html
+[api]: https://repo-review.readthedocs.io/en/latest/api/repo_review.html
+
 
 <!-- prettier-ignore-end -->

repo_review-0.9.3/docs/api/repo_review.resources.rst

@@ -0,0 +1,7 @@
+repo\_review.resources package
+==============================
+
+.. automodule:: repo_review.resources
+   :members:
+   :undoc-members:
+   :show-inheritance:

{repo_review-0.9.2 → repo_review-0.9.3}/docs/api/repo_review.rst

@@ -6,6 +6,14 @@ repo\_review package
    :undoc-members:
    :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   repo_review.resources
+
 Submodules
 ----------
 
@@ -56,3 +64,11 @@ repo\_review.processor module
    :members:
    :undoc-members:
    :show-inheritance:
+
+repo\_review.schema module
+--------------------------
+
+.. automodule:: repo_review.schema
+   :members:
+   :undoc-members:
+   :show-inheritance:

{repo_review-0.9.2 → repo_review-0.9.3}/docs/conf.py

@@ -61,6 +61,8 @@ sphinx_github_changelog_token = os.environ.get("GITHUB_API_TOKEN")
 commit = os.environ.get("READTHEDOCS_GIT_COMMIT_HASH", "main")
 code_url = "https://github.com/scientific-python/repo-review/blob"
 
+linkcheck_ignore = [r"https://pypi.org/project/repo-review/v0\.[23456]"]
+
 
 def linkcode_resolve(domain: str, info: dict[str, str]) -> str | None:
     if domain != "py":

{repo_review-0.9.2 → repo_review-0.9.3}/docs/index.html

@@ -63,7 +63,12 @@
       root.render(
         <App
           header={true}
-          deps={["sp-repo-review==2023.08.03", "repo-review==0.9.2"]}
+          deps={[
+            "sp-repo-review==2023.08.23",
+            "repo-review==0.9.2",
+            "validate-pyproject==0.14",
+            "scikit-build-core==0.5.0",
+          ]}
         />,
       );
     </script>

{repo_review-0.9.2 → repo_review-0.9.3}/docs/plugins.md

@@ -8,7 +8,66 @@ standardized backend, such as `hatchling`, `flit-core`, `pdm-backend`, or
 `setuptools>=61`. If you are using some other build backend, please adjust
 accordingly.
 
-## Avoiding CLI requirements on WebAssembly usage
+## Entry points
+
+You need to specify entry points as listed in the fixtures/checks/families
+pages in order for repo-review to use your plugin. In summary, they look like this:
+
+```toml
+[project.entry-points]
+"repo_review.fixtures".fixture_name = "my_plugin_package.my_fixture_module:fixture_name"
+"repo_review.checks".anything = "my_plugin_package.my_checks_module:repo_review_checks"
+"repo_review.families".anything = "my_plugin_package.my_family_module:repo_review_families"
+```
+
+Only the fixture entry-point name matters (it's the name of the fixture);
+checks and families produce multiple items, so they can be under any name.
+
+## Testing
+
+If you'd like to test your plugin, add `repo-review; python_version>="3.10"` to
+your test dependencies (if your package is only a plugin for repo-review, you
+don't need the Python limit there). Then add some valid and/or invalid examples
+to your test suite (you can write them out during testing, as well, which is
+what is shown below). Then a test looks like this:
+
+```python
+from pathlib import Path
+
+import pytest
+
+repo_review_processor = pytest.importorskip("repo_review.processor")
+
+
+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]")
+    processed = repo_review_processor.process(d)
+    assert all(r.result for r in processed.results), f"{processed.results}"
+```
+
+You have `processed.results` and `processed.families` from the return of
+{func}`~repo_review.processor.process` to work with. You can also run
+{func}`~repo_review.processor.collect_all` to get `.fixtures`, `.checks`, and
+`.families`.
+
+## An existing package
+
+Since writing a plugin does not require depending on repo-review, you can also
+integrate your plugins into existing packages. If that's the case, you only
+need to add your entry-points (see the links above), and tests.
+
+## A plugin-only package
+
+If you are writing a package that is only a plugin for repo-review, there are
+several things you can do if you'd like a user to be able to run the package
+directly. `sp-repo-review` does these things to make it easy to run as a
+complete package. This design is mostly useful if you are providing a complete
+set of checks for an ecosystem.
+
+### Avoiding CLI requirements on WebAssembly usage
 
 Repo-review uses `repo-review[cli]` to keep CLI requirements from being
 included in the base package, and plugins can follow this if they want to be
@@ -21,7 +80,7 @@ cli = [
 ]
 ```
 
-## Custom entry-point (optional)
+### Custom entry-point (optional)
 
 If you want to provide your own CLI name, you can
 add this to your `pyproject.toml`:
@@ -34,7 +93,7 @@ my_plugin_cli_name = "repo_review.__main__:main"
 However, there is no benefit over just running `repo-review`, so this is not
 really recommended.
 
-## Pipx run support (recommended)
+### Pipx run support (recommended)
 
 If you chose not to add a custom command-line entry point (above), you should
 still support `pipx run <your-plugin>`, and you can do that by adding the
@@ -45,7 +104,7 @@ following to your `pyproject.toml`:
 my_plugin_package_name = "repo_review.__main__:main"
 ```
 
-## Pre-commit support
+### Pre-commit support
 
 You can add a `.pre-commit-hooks.yaml` file with contents similar to this to
 natively support pre-commit:
@@ -63,7 +122,7 @@ minimum_pre_commit_version: 2.9.0
 You can also narrow down the `files` / `types_or` if your plugin only supports
 a subset of files (which most should).
 
-## GitHub Actions support
+### GitHub Actions support
 
 You can add an `action.yml` file similar to this to natively support GitHub
 Actions & dependabot:

{repo_review-0.9.2 → repo_review-0.9.3}/pyproject.toml

@@ -44,7 +44,8 @@ cli = [
 ]
 test = [
   "pytest >=7",
-  "sp-repo-review",
+  "sp-repo-review >=2023.08.23",
+  "validate-pyproject >=0.14",
 ]
 dev = [
   "repo-review[test,cli]",
@@ -75,6 +76,9 @@ repo-review = "repo_review.__main__:main"
 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"
@@ -180,3 +184,7 @@ flake8-unused-arguments.ignore-variadic-names = true
 [tool.ruff.per-file-ignores]
 "src/repo_review/_compat/**.py" = ["TID251"]
 "src/**/__main__.py" = ["T20"]
+
+
+[tool.repo-review]
+ignore = ["PC110"]

{repo_review-0.9.2 → repo_review-0.9.3}/src/repo_review/_version.py

@@ -1,4 +1,4 @@
 # file generated by setuptools_scm
 # don't change, don't track in version control
-__version__ = version = '0.9.2'
-__version_tuple__ = version_tuple = (0, 9, 2)
+__version__ = version = '0.9.3'
+__version_tuple__ = version_tuple = (0, 9, 3)

repo_review-0.9.3/src/repo_review/resources/__init__.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+import importlib.resources
+
+__all__ = ["resources"]
+
+
+resources = importlib.resources.files(__name__)

repo_review-0.9.3/src/repo_review/resources/repo-review.schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://github.com/scientific-python/repo-review/blob/main/src/repo_review/resources/repo-review.schema.json",
+  "description": "Repo-review's settings.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "select": {
+      "$ref": "#/$defs/checks"
+    },
+    "ignore": {
+      "$ref": "#/$defs/checks"
+    }
+  },
+  "$defs": {
+    "checks": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Z]+[0-9]*$"
+      }
+    }
+  }
+}

repo_review-0.9.3/src/repo_review/schema.py

@@ -0,0 +1,24 @@
+"""
+This accesses the schema for repo-review's tool section.
+"""
+
+from __future__ import annotations
+
+import json
+from typing import Any
+
+from .resources import resources
+
+__all__ = ["get_schema"]
+
+
+def __dir__() -> list[str]:
+    return __all__
+
+
+def get_schema(tool_name: str = "repo-review") -> dict[str, Any]:
+    "Get the stored complete schema for repo-review settings."
+    assert tool_name == "repo-review", "Only repo-review is supported."
+
+    with resources.joinpath("repo-review.schema.json").open(encoding="utf-8") as f:
+        return json.load(f)  # type: ignore[no-any-return]

repo_review-0.9.3/tests/test_package.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+import textwrap
+from pathlib import Path
+
+import pytest
+
+import repo_review as m
+from repo_review.processor import process
+
+DIR = Path(__file__).parent.resolve()
+
+
+def test_version():
+    assert m.__version__
+
+
+def test_local():
+    pytest.importorskip("sp_repo_review")
+    pytest.importorskip("validate_pyproject")
+    package = DIR.parent
+    results = process(package)
+    assert "hatchling.build" in results.families["general"]["description"]
+    assert "BSD License" in results.families["general"]["description"]
+    assert "[tool.repo-review]" in results.families["validate-pyproject"]["description"]
+    for result in results.results:
+        assert result.result
+
+
+def test_broken_validate_pyproject(tmp_path: Path) -> None:
+    pytest.importorskip("validate_pyproject")
+    tmp_path.joinpath("pyproject.toml").write_text(
+        textwrap.dedent(
+            """\
+                [tool.repo-review]
+                ignore = ["a2"]
+            """
+        )
+    )
+
+    results = process(tmp_path)
+
+    (result,) = (r for r in results.results if r.name == "VPP001")
+    assert "must match pattern" in result.err_msg
+    assert not result.result

repo_review-0.9.2/tests/test_package.py

@@ -1,29 +0,0 @@
-from __future__ import annotations
-
-from pathlib import Path
-
-import pytest
-
-import repo_review as m
-from repo_review.ghpath import GHPath
-from repo_review.processor import process
-
-DIR = Path(__file__).parent.resolve()
-
-
-def test_version():
-    assert m.__version__
-
-
-@pytest.mark.skip(reason="Can be rate limited")
-def test_pyodide():
-    pytest.importorskip("sp_repo_review")
-    package = GHPath(repo="scientific-python/repo-review", branch="main")
-    results = process(package)
-    assert results
-
-
-def test_local():
-    package = DIR.parent
-    results = process(package)
-    assert results