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

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

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

{repo_review-0.10.6 → repo_review-0.11.0}/.github/CONTRIBUTING.md

@@ -5,28 +5,32 @@ detailed description of best practices for developing Scikit-HEP packages.
 
 ## Quick development
 
-The fastest way to start with development is to use nox. If you don't have nox,
-you can use `pipx run nox` to run it without installing, or `pipx install nox`.
-If you don't have pipx (pip for applications), then you can install with with
-`pip install pipx` (the only case were installing an application with regular
-pip is reasonable). If you use macOS, then pipx and nox are both in brew, use
-`brew install pipx nox`.
+The fastest way to start with development is to use hatch. If you don't have
+hatch, you can use `pipx run hatch` to run it without installing, or `pipx
+install hatch`. If you don't have pipx (pip for applications), then you can
+install with with `pip install pipx` (the only case were installing an
+application with regular pip is reasonable). If you use macOS, then pipx and
+hatch are both in brew, use `brew install pipx hatch`. Hatch 1.10+ is required.
 
-To use, run `nox`. This will lint and test using every installed version of
-Python on your system, skipping ones that are not installed. You can also run
-specific jobs:
+Here are some common tasks you might want to run:
 
 ```console
-$ nox -s lint  # Lint only
-$ nox -s tests # Tests
-$ nox -s docs -- --serve  # Build and serve the docs
-$ nox -s build  # Make an SDist and wheel
+$ hatch run lint:lint        # all linters (pre-commit)
+$ hatch run pylint:lint      # pylint
+$ hatch fmt                  # just format & basic lint
+$ hatch tests                # run the tests
+$ hatch build                # build SDist and wheel
+$ hatch run docs:serve       # build and serve the docs
+$ hatch run docs:html        # just build the docs
+$ hatch run docs:man         # build manpage
+$ hatch run docs:linkcheck   # check for broken links
+$ hatch run api-docs:build   # rebuild the API docs
+$ hatch run webapp:serve     # serve the webapp
+$ hatch run example:repo-review <args> # Run an example
 ```
 
-Nox handles everything for you, including setting up an temporary virtual
-environment for each run.
-
-You can also use `nox -s run -- .` to run an example set of checks on a repo.
+Hatch handles everything for you, including setting up an temporary virtual
+environment.
 
 ## Setting up a development environment manually
 
@@ -71,19 +75,25 @@ pytest
 You can build the docs using:
 
 ```bash
-nox -s docs
+hatch run docs:docs
 ```
 
 You can see a preview with:
 
 ```bash
-nox -s docs -- --serve
+hatch run docs:serve
+```
+
+You can rebuild the API docs with:
+
+```bash
+$ hatch run api-docs:build
 ```
 
 ## Pre-commit
 
 This project uses pre-commit for all style checking. While you can run it with
-nox, this is such an important tool that it deserves to be installed on its
+hatch, this is such an important tool that it deserves to be installed on its
 own. Install pre-commit and run:
 
 ```bash
@@ -94,5 +104,5 @@ to check all files.
 
 ## Running DevContainer
 
-You can use DevContainer, such as in GitHub Codespaces or locally. Nox and a
+You can use DevContainer, such as in GitHub Codespaces or locally. Hatch and a
 local install will be available.

repo_review-0.11.0/.github/ISSUE_TEMPLATE/new-issue.md

@@ -0,0 +1,11 @@
+---
+name: New Issue
+about: Prepare a new bug report or feature request
+title: ""
+labels: ""
+assignees: ""
+---
+
+<!--
+Thanks for making a bug report or feature request! Please note, repo-review is a framework for running checks. If you have an issue with a particular check, please open the issue with the plugin that provides the check. The repo-review demo uses the sp-repo-review plugin, which lives at http://github.com/scientific-python/cookie, for example.
+-->

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

@@ -32,16 +32,14 @@ jobs:
       - name: Run PyLint
         run: |
           echo "::add-matcher::$GITHUB_WORKSPACE/.github/matchers/pylint.json"
-          pipx run --python=python nox -s pylint
+          pipx run --python=python hatch run pylint:lint
 
   checks:
-    name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
+    name: Check Python on ${{ matrix.runs-on }}
     runs-on: ${{ matrix.runs-on }}
-    needs: [pre-commit]
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.10", "3.11", "3.12"]
         runs-on: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
@@ -51,18 +49,19 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: |
+            3.10
+            3.11
+            3.12
 
       - name: Setup uv
         uses: yezz123/setup-uv@v4
-        with:
-          uv-venv: ".venv"
 
-      - name: Install package
-        run: uv pip install .[test,cli]
+      - name: Install hatch
+        run: uv pip install --system hatch
 
-      - name: Test package
-        run: python -m pytest -ra
+      - name: Test package (all Pythons)
+        run: hatch test -a
         env:
           PYTHONUTF8: "1"
 
@@ -88,19 +87,22 @@ jobs:
       - name: Setup uv
         uses: yezz123/setup-uv@v4
 
-      - uses: wntrblm/nox@2024.04.15
+      - uses: actions/setup-python@v5
         with:
-          python-versions: "3.11"
+          python-version: "3.12"
+
+      - name: Install hatch
+        run: uv pip install --system hatch
 
       - name: Linkcheck
-        run: nox -s docs -- -b linkcheck
+        run: hatch run docs:linkcheck
 
       - name: Build docs with warnings as errors
-        run: nox -s docs -- -W
+        run: hatch run docs:html -W
 
       - name: Verify no changes required to API docs
         run: |
-          nox -s build_api_docs
+          hatch run api-docs:build
           git diff --exit-code
 
   action:
@@ -114,4 +116,4 @@ jobs:
       - name: Run repo-review action
         uses: ./
         with:
-          plugins: sp-repo-review==2024.03.10
+          plugins: sp-repo-review==2024.04.23

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

@@ -10,7 +10,7 @@ repos:
         additional_dependencies: [black==23.*]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.4.1"
+    rev: "v0.4.2"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
@@ -44,7 +44,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.9.0
+    rev: v1.10.0
     hooks:
       - id: mypy
         files: (src|web|tests)
@@ -75,3 +75,15 @@ repos:
         language: pygrep
         entry: PyBind|Numpy|Cmake|CCache|Github|PyTest
         exclude: .pre-commit-config.yaml
+
+  - repo: https://github.com/henryiii/validate-pyproject-schema-store
+    rev: 2024.04.29
+    hooks:
+      - id: validate-pyproject
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.28.2
+    hooks:
+      - id: check-dependabot
+      - id: check-github-workflows
+      - id: check-readthedocs

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: repo_review
-Version: 0.10.6
+Version: 0.11.0
 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

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

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

{repo_review-0.10.6 → repo_review-0.11.0}/docs/webapp.js

@@ -33,7 +33,6 @@ function IfUrlLink({ name, url, color }) {
     return (
       <MaterialUI.Typography
         sx={{ display: "inline" }}
-        component="span"
         variant="body2"
         color={color}
         component="a"
@@ -192,12 +191,13 @@ function MyThemeProvider(props) {
 class App extends React.Component {
   constructor(props) {
     super(props);
-    const deps_str = props.deps.join(" ");
+    const inner_deps_str = props.deps.join("\n");
+    const deps_str = `<pre><code>${inner_deps_str}</code></pre>`;
     this.state = {
       results: [],
       repo: urlParams.get("repo") || "",
       branch: urlParams.get("branch") || "",
-      msg: `${DEFAULT_MSG} Packages: ${deps_str}`,
+      msg: `<p>${DEFAULT_MSG}</p><h4>Packages:</h4> ${deps_str}`,
       progress: false,
       err_msg: "",
       url: "",
@@ -229,12 +229,9 @@ class App extends React.Component {
       var families_checks;
       try {
         families_checks = pyodide.runPython(`
-          from pyodide.http import open_url
           from repo_review.processor import process, md_as_html
           from repo_review.ghpath import GHPath
 
-          GHPath.open_url = staticmethod(open_url)
-
           package = GHPath(repo="${state.repo}", branch="${state.branch}")
           result = process(package)
 
@@ -366,7 +363,7 @@ class App extends React.Component {
           <MaterialUI.Paper elevation={3}>
             <MaterialUI.Box sx={{ p: 2 }}>
               <MaterialUI.Typography variant="body1" component="div">
-                {this.state.msg}
+                <span dangerouslySetInnerHTML={{ __html: this.state.msg }} />
               </MaterialUI.Typography>
               {this.state.progress && <MaterialUI.LinearProgress />}
               {this.state.err_msg && (

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

@@ -84,6 +84,46 @@ repo-review = "repo_review.schema:get_schema"
 version.source = "vcs"
 build.hooks.vcs.version-file = "src/repo_review/_version.py"
 
+[tool.hatch.envs.default]
+installer = "uv"
+
+[tool.hatch.envs.hatch-test]
+features = ["test", "cli"]
+
+[tool.hatch.envs.lint]
+dependencies = ["pre-commit"]
+skip-install = true
+scripts.lint = "pre-commit run --all-files --show-diff-on-failure {args}"
+
+[tool.hatch.envs.pylint]
+features = ["cli"]
+dependencies = ["pylint"]
+scripts.lint = "pylint repo_review {args}"
+
+[tool.hatch.envs.docs]
+features = ["docs"]
+dependencies = ["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}"
+scripts.man = "sphinx-build --keep-going -n -T -b=man docs docs/_build/man {args}"
+
+[tool.hatch.envs.api-docs]
+skip-install = true
+dependencies = ["sphinx"]
+scripts.build = "sphinx-apidoc -o docs/api/ --module-first --no-toc --force src/repo_review"
+
+[tool.hatch.envs.example]
+features = ["cli"]
+post-install-commands = ["$HATCH_UV pip install -e tests/test_utilities"]
+
+[tool.hatch.envs.webapp]
+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"]
+
 
 [tool.pytest.ini_options]
 minversion = "7.0"
@@ -92,6 +132,8 @@ xfail_strict = true
 log_cli_level = "INFO"
 filterwarnings = [
   "error",
+  "ignore:OptionHighlighter:DeprecationWarning",  # rich-click triggers its own warning
+  "ignore:`highlighter`:DeprecationWarning",  # rich-click triggers its own warning
 ]
 testpaths = ["tests"]
 pythonpath = ["tests/test_utilities"]
@@ -113,8 +155,9 @@ disallow_untyped_defs = true
 
 
 [tool.pylint]
-master.py-version = "3.10"
-master.ignore-paths= ["src/repo_review/_version.py"]
+py-version = "3.10"
+ignore-paths = ["src/repo_review/_version.py"]
+ignored-modules = ["pyodide"]
 reports.output-format = "colorized"
 similarities.ignore-imports = "yes"
 messages_control.disable = [
@@ -131,6 +174,7 @@ messages_control.disable = [
   "no-member",  # better handled by mypy, etc.
   "used-before-assignment",  # False positive on conditional import
   "unnecessary-ellipsis",  # Not correct for typing
+  "import-outside-toplevel",  # better handled elsewhere
 ]
 
 
@@ -160,7 +204,7 @@ extend-select = [
   "YTT",         # flake8-2020
 ]
 ignore = [
-  "ISC001", # May collide with formatter
+  "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

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

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

{repo_review-0.10.6 → repo_review-0.11.0}/src/repo_review/ghpath.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 import dataclasses
 import io
 import json
+import sys
 import typing
 from collections.abc import Iterator
 from typing import Literal
@@ -47,7 +48,12 @@ class GHPath(Traversable):
 
     @staticmethod
     def open_url(url: str) -> io.StringIO:
-        "This method can be overridden for pyodide with pyodide.open_url"
+        "This method can be overridden manually for WASM. Supports pyodide currently."
+        if sys.platform == "emscripten":
+            import pyodide.http
+
+            return pyodide.http.open_url(url)
+
         import urllib.request  # pylint: disable=import-outside-toplevel
 
         with urllib.request.urlopen(url) as response:

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

@@ -41,7 +41,7 @@ def multiple_packages(tmp_path: Path) -> tuple[str, str]:
 @pytest.mark.usefixtures("local_entry_points")
 def test_multiple_packages_rich(multiple_packages: Sequence[str]) -> None:
     runner = CliRunner()
-    result = runner.invoke(main, [*multiple_packages])
+    result = runner.invoke(main, [*multiple_packages], catch_exceptions=False)
     assert result.exit_code == 0
     assert "package_1" in result.output
     assert "package_2" in result.output
@@ -51,7 +51,9 @@ def test_multiple_packages_rich(multiple_packages: Sequence[str]) -> None:
 @pytest.mark.usefixtures("local_entry_points")
 def test_multiple_packages_json(multiple_packages: Sequence[str]) -> None:
     runner = CliRunner()
-    result = runner.invoke(main, [*multiple_packages, "--format", "json"])
+    result = runner.invoke(
+        main, [*multiple_packages, "--format", "json"], catch_exceptions=False
+    )
     assert result.exit_code == 0
     output = json.loads(result.output)
     assert len(output) == 2
@@ -62,7 +64,9 @@ def test_multiple_packages_json(multiple_packages: Sequence[str]) -> None:
 @pytest.mark.usefixtures("local_entry_points")
 def test_multiple_packages_html(multiple_packages: Sequence[str]) -> None:
     runner = CliRunner()
-    result = runner.invoke(main, [*multiple_packages, "--format", "html"])
+    result = runner.invoke(
+        main, [*multiple_packages, "--format", "html"], catch_exceptions=False
+    )
     assert result.exit_code == 0
     tree = ET.fromstring(f"<body>{result.output}</body>")
     assert len(tree) == 2

repo_review-0.10.6/noxfile.py

@@ -1,138 +0,0 @@
-from __future__ import annotations
-
-import argparse
-import shutil
-from pathlib import Path
-
-import nox
-
-DIR = Path(__file__).parent.resolve()
-
-nox.needs_version = ">=2024.3.2"
-nox.options.default_venv_backend = "uv|virtualenv"
-nox.options.sessions = ["lint", "pylint", "tests"]
-
-
-@nox.session(reuse_venv=True)
-def run(session: nox.Session) -> None:
-    """
-    Run the program with a few example checks.
-    """
-
-    session.install("-e", ".[cli]")
-    session.install("-e", "tests/test_utilities")
-    session.run("python", "-m", "repo_review", *session.posargs)
-
-
-@nox.session
-def lint(session: nox.Session) -> None:
-    """
-    Run the linter.
-    """
-    session.install("pre-commit")
-    session.run("pre-commit", "run", "--all-files", *session.posargs)
-
-
-@nox.session
-def pylint(session: nox.Session) -> None:
-    """
-    Run PyLint.
-    """
-    # This needs to be installed into the package environment, and is slower
-    # than a pre-commit check
-    session.install("-e.[cli]", "pylint")
-    session.run("pylint", "src", *session.posargs)
-
-
-@nox.session
-def tests(session: nox.Session) -> None:
-    """
-    Run the unit and regular tests.
-    """
-    session.install("-e.[test,cli]")
-    session.run("pytest", *session.posargs)
-
-
-@nox.session(reuse_venv=True)
-def build(session: nox.Session) -> None:
-    """
-    Build an SDist and wheel.
-    """
-
-    build_p = DIR.joinpath("build")
-    if build_p.exists():
-        shutil.rmtree(build_p)
-
-    session.install("build")
-    session.run("python", "-m", "build")
-
-
-@nox.session(venv_backend="none")
-def serve(session: nox.Session) -> None:
-    """
-    Serve the webapp.
-    """
-
-    session.cd("docs")
-    session.log("Serving on http://localhost:8080")
-    session.run("python3", "-m", "http.server", "8080")
-
-
-@nox.session(reuse_venv=True)
-def docs(session: nox.Session) -> None:
-    """
-    Build the docs. Pass "--serve" to serve.
-    """
-
-    parser = argparse.ArgumentParser()
-    parser.add_argument("--serve", action="store_true", help="Serve after building")
-    parser.add_argument(
-        "-b", dest="builder", default="html", help="Build target (default: html)"
-    )
-    args, posargs = parser.parse_known_args(session.posargs)
-
-    if args.builder != "html" and args.serve:
-        session.error("Must not specify non-HTML builder with --serve")
-
-    extra_installs = ["sphinx-autobuild"] if args.serve else []
-
-    session.install("-e.[docs]", *extra_installs)
-    session.chdir("docs")
-
-    if args.builder == "linkcheck":
-        session.run(
-            "sphinx-build", "-b", "linkcheck", ".", "_build/linkcheck", *posargs
-        )
-        return
-
-    shared_args = (
-        "-n",  # nitpicky mode
-        "-T",  # full tracebacks
-        f"-b={args.builder}",
-        ".",
-        f"_build/{args.builder}",
-        *posargs,
-    )
-
-    if args.serve:
-        session.run("sphinx-autobuild", *shared_args)
-    else:
-        session.run("sphinx-build", "--keep-going", *shared_args)
-
-
-@nox.session
-def build_api_docs(session: nox.Session) -> None:
-    """
-    Build (regenerate) API docs.
-    """
-    session.install("sphinx")
-    session.chdir("docs")
-    session.run(
-        "sphinx-apidoc",
-        "-o",
-        "api/",
-        "--module-first",
-        "--no-toc",
-        "--force",
-        "../src/repo_review",
-    )