repo-review 0.9.2__py3-none-any.whl → 0.9.3__py3-none-any.whl

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/resources/__init__.py

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

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/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.2.dist-info → repo_review-0.9.3.dist-info}/METADATA

@@ -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.dist-info → repo_review-0.9.3.dist-info}/RECORD

@@ -1,6 +1,6 @@
 repo_review/__init__.py,sha256=Mwl2Lp046LmlrYhaYX-_krbiWhPG5VLFHVrDvSTtnq8,230
 repo_review/__main__.py,sha256=o_-WXKt_lcwyUpL4uHttxoqGfeZ6wcDaebYpsBF8LPo,8157
-repo_review/_version.py,sha256=t2HJ5q34aM9MjZF2siod7ZXTvaH_aHYeO-QChiNfrq4,160
+repo_review/_version.py,sha256=pBH2D3-n2O0-LXZHMYk_Esnj71yN3IieWKkVDv2_kk4,160
 repo_review/_version.pyi,sha256=j5kbzfm6lOn8BzASXWjGIA1yT0OlHTWqlbyZ8Si_o0E,118
 repo_review/checks.py,sha256=jyW_sHwNU0L3BNSDNRjPlW9YJYrMEc6R5o13s6sdHa4,3625
 repo_review/families.py,sha256=TEMQY3whMj8b3iVlWyVsTa0CAZexXRCFXq5uPIkV6bs,2389
@@ -9,14 +9,17 @@ repo_review/ghpath.py,sha256=CArlWT4yNgIIoDZ4pVNxucmAdUUMkJSkkROtk35q5qc,6010
 repo_review/html.py,sha256=0eXaCAjvXRRGcffqBuUJJ7010Wzfc6aXGwet7MrodEQ,2449
 repo_review/processor.py,sha256=l_rt39yLI8xXbSUQzGam4YRUdxWnV5q2dm7TVDUZCZk,7820
 repo_review/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+repo_review/schema.py,sha256=U_iox0khN1oEHCCB5ILffjRvZLG7BR-aaip9QEpMkJk,593
 repo_review/_compat/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 repo_review/_compat/tomllib.py,sha256=caR8Mj-hSBLE2zqdLLjzwOdCBOfikVqS8pWkc4K5vgc,233
 repo_review/_compat/typing.py,sha256=vXfYiJHUaqMShRMbJi0VUg2V59UV-oxceZKSBZ3tfts,246
 repo_review/_compat/importlib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 repo_review/_compat/importlib/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 repo_review/_compat/importlib/resources/abc.py,sha256=0DXPlrQLCeUNTmY2ex5FlR8_T3FfNllfvVF8n2-ta9w,256
-repo_review-0.9.2.dist-info/METADATA,sha256=WX6rM9DxNBdpXxywX--5CG8lrwRpiTnbx_kHt6G3Kyc,8397
-repo_review-0.9.2.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
-repo_review-0.9.2.dist-info/entry_points.txt,sha256=U2kE_SW4dEAVBESDopUDYPD8Nc46gG7ilSVScPFG1Lo,166
-repo_review-0.9.2.dist-info/licenses/LICENSE,sha256=X7yOxzyAEckYl17p01lZzbraqDVmWEWXE8BnKKRrh7c,1525
-repo_review-0.9.2.dist-info/RECORD,,
+repo_review/resources/__init__.py,sha256=RBBaUp-hQrIYBqbAT0MytCXEjDmqVsCjiEgdK_K3dN4,138
+repo_review/resources/repo-review.schema.json,sha256=Ljna-BRuoKihOnJ5_78Fgs0ZrYHlgohmtS6x37TJbDg,556
+repo_review-0.9.3.dist-info/METADATA,sha256=IEVTueu0WtFn9zzHbnUYF-H0LlL1YFvhIhv4495KWRw,10233
+repo_review-0.9.3.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
+repo_review-0.9.3.dist-info/entry_points.txt,sha256=9XaDWanm31NNpXOpjZh2HxSXR5owVdYJ2cbNG5D8wY8,244
+repo_review-0.9.3.dist-info/licenses/LICENSE,sha256=X7yOxzyAEckYl17p01lZzbraqDVmWEWXE8BnKKRrh7c,1525
+repo_review-0.9.3.dist-info/RECORD,,

{repo_review-0.9.2.dist-info → repo_review-0.9.3.dist-info}/entry_points.txt

@@ -4,3 +4,6 @@ repo-review = repo_review.__main__:main
 [repo_review.fixtures]
 list_all = repo_review.fixtures:list_all
 pyproject = repo_review.fixtures:pyproject
+
+[validate_pyproject.tool_schema]
+repo-review = repo_review.schema:get_schema