feat: add sp-repo-review

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: henryiii

.pre-commit-config.yaml

@@ -10,8 +10,20 @@ repos:
     hooks:
       - id: black-jupyter
 
+  - repo: https://github.com/asottile/blacken-docs
+    rev: 1.13.0
+    hooks:
+      - id: blacken-docs
+        additional_dependencies: [black==23.1.0]
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.0.270"
+    hooks:
+      - id: ruff
+        args: ["--fix", "--show-fixes"]
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.4.0"
+    rev: v4.4.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -21,8 +33,33 @@ repos:
       - id: debug-statements
       - id: end-of-file-fixer
       - id: mixed-line-ending
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+      - id: requirements-txt-fixer
       - id: trailing-whitespace
 
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.3.0
+    hooks:
+      - id: mypy
+        files: "(src|web|tests)"
+        args:
+          - click
+          - markdown-it-py
+          - pytest
+          - repo-review
+          - rich
+          - tomli
+          - types-PyYAML
+        additional_dependencies:
+
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: "v2.7.1"
     hooks:
@@ -31,12 +68,6 @@ repos:
         args: [--prose-wrap=always]
         exclude: ^.readthedocs.yml
 
-  - repo: https://github.com/asottile/blacken-docs
-    rev: "1.13.0"
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: [black==23.3.0]
-
   - repo: https://github.com/codespell-project/codespell
     rev: "v2.2.4"
     hooks:

noxfile.py

@@ -2,6 +2,7 @@
 
 import json
 import re
+import shutil
 import urllib.request
 from pathlib import Path
 
@@ -28,8 +29,7 @@ def make_cookie(session: nox.Session, backend: str) -> None:
 
     package_dir = Path(f"cookie-{backend}")
 
-    with open("input.yml", "w") as f:
-        f.write(JOB_FILE.format(backend=backend))
+    Path("input.yml").write_text(JOB_FILE.format(backend=backend), encoding="utf-8")
 
     session.run(
         "cookiecutter",
@@ -193,15 +193,15 @@ def gha_bump(session: nox.Session) -> None:
     old_versions = {m[1]: m[2] for m in GHA_VERS.finditer(full_txt)}
 
     for repo, old_version in old_versions.items():
-        print(f"{repo}: {old_version}")
+        session.log(f"{repo}: {old_version}")
         response = urllib.request.urlopen(f"https://api.github.com/repos/{repo}/tags")
         tags_js = json.loads(response.read())
         tags = [
             x["name"] for x in tags_js if x["name"].count(".") == old_version.count(".")
         ]
         new_version = tags[0]
         if new_version != old_version:
-            print(f"Convert {repo}: {old_version} -> {new_version}")
+            session.log(f"Convert {repo}: {old_version} -> {new_version}")
             for page in pages:
                 txt = page.read_text()
                 txt = txt.replace(
@@ -210,11 +210,57 @@ def gha_bump(session: nox.Session) -> None:
                 page.write_text(txt)
 
 
-@nox.session(venv_backend=None)
-def sync(session: nox.Session) -> None:
-    for f in Path("docs/pages/developers").glob("*.md"):
-        if f.name == "index.md":
-            continue
-        url = f"https://raw.githubusercontent.com/scikit-hep/scikit-hep.github.io/main/pages/developers/{f.name}"
-        response = urllib.request.urlopen(url)
-        f.write_text(response.read().decode("utf-8"))
+# -- Repo review --
+
+
+@nox.session(reuse_venv=True)
+def rr_run(session: nox.Session) -> None:
+    """
+    Run the program
+    """
+
+    session.install("-e", ".[cli]")
+    session.run("python", "-m", "repo_review", *session.posargs)
+
+
+@nox.session
+def rr_lint(session: nox.Session) -> None:
+    """
+    Run the linter.
+    """
+    session.install("pre-commit")
+    session.run("pre-commit", "run", "--all-files", *session.posargs)
+
+
+@nox.session
+def rr_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 rr_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 rr_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")

pyproject.toml

@@ -0,0 +1,168 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[project]
+name = "sp_repo_review"
+authors = [
+  { name = "Henry Schreiner", email = "henryfs@princeton.edu" },
+]
+license = { file = "LICENSE" }
+description = "Review repos for compliance to the Scientific-Python development guidelines"
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+  "License :: OSI Approved :: BSD License",
+  "Topic :: Scientific/Engineering",
+  "Intended Audience :: Science/Research",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "License :: OSI Approved :: BSD License",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Development Status :: 4 - Beta",
+]
+dynamic = ["version"]
+dependencies = [
+  "pyyaml",
+  "repo-review",
+]
+
+[project.optional-dependencies]
+cli = [
+  "click>=8",
+  "rich>=12.2",
+]
+test = [
+  "pytest >=7",
+]
+dev = [
+  "pytest >=7",
+]
+
+[project.urls]
+homepage = "https://github.com/scientific-python/cookie"
+webpage = "https://scientific-python.github.io/cookie"
+
+[project.scripts]
+sp-repo-review = "repo_review.__main__:main"
+
+[project.entry-points."repo_review.checks"]
+general = "sp_repo_review.checks.general:repo_review_checks"
+pyproject = "sp_repo_review.checks.pyproject:repo_review_checks"
+precommit = "sp_repo_review.checks.precommit:repo_review_checks"
+ruff = "sp_repo_review.checks.ruff:repo_review_checks"
+mypy = "sp_repo_review.checks.mypy:repo_review_checks"
+github = "sp_repo_review.checks.github:repo_review_checks"
+
+[project.entry-points."repo_review.fixtures"]
+workflows = "sp_repo_review.checks.github:workflows"
+dependabot = "sp_repo_review.checks.github:dependabot"
+precommit = "sp_repo_review.checks.precommit:precommit"
+
+[project.entry-points."repo_review.families"]
+scikit-hep = "sp_repo_review.families:get_familes"
+
+[tool.hatch]
+version.path = "src/sp_repo_review/__init__.py"
+
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = ["-ra", "--strict-markers", "--strict-config"]
+xfail_strict = true
+log_cli_level = "INFO"
+filterwarnings = [
+  'error',
+  'ignore:(ast.Str|Attribute s|ast.NameConstant|ast.Num) is deprecated:DeprecationWarning:_pytest',
+]
+norecursedirs = ['{{cookiecutter.project_name}}']
+testpaths = ["tests"]
+
+
+[tool.mypy]
+files = ["src", "web", "tests"]
+python_version = "3.10"
+warn_unused_configs = true
+strict = true
+show_error_codes = true
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
+warn_unreachable = true
+disallow_untyped_defs = false
+
+[[tool.mypy.overrides]]
+module = "sp_repo_review.*"
+disallow_untyped_defs = true
+
+[tool.pylint]
+master.py-version = "3.10"
+master.ignore-paths= ["src/sp_repo_review/_version.py"]
+reports.output-format = "colorized"
+similarities.ignore-imports = "yes"
+messages_control.disable = [
+  "design",
+  "fixme",
+  "line-too-long",
+  "wrong-import-position",
+  "redefined-builtin",
+  "missing-module-docstring",
+  "missing-class-docstring",
+  "missing-function-docstring",
+  "invalid-name",
+  "redefined-outer-name",
+  "no-member",  # better handled by mypy, etc.
+]
+
+
+[tool.ruff]
+select = [
+  "E", "F", "W", # flake8
+  "B", "B904",   # flake8-bugbear
+  "I",           # isort
+  "ARG",         # flake8-unused-arguments
+  "C4",          # flake8-comprehensions
+  "EM",          # flake8-errmsg
+  "ICN",         # flake8-import-conventions
+  "ISC",         # flake8-implicit-str-concat
+  "PGH",         # pygrep-hooks
+  "PIE",         # flake8-pie
+  "PL",          # pylint
+  "PT",          # flake8-pytest-style
+  "PTH",         # flake8-use-pathlib
+  "RET",         # flake8-return
+  "RUF",         # Ruff-specific
+  "SIM",         # flake8-simplify
+  "TID251",      # flake8-tidy-imports.banned-api
+  "T20",         # flake8-print
+  "UP",          # pyupgrade
+  "YTT",         # flake8-2020
+]
+extend-ignore = [
+  "PLR",    # Design related pylint codes
+  "E501",   # Line too long
+  "PT004",  # Incorrect check, usefixtures is the correct way to do this
+]
+target-version = "py310"
+src = ["src"]
+unfixable = [
+  "T20",  # Removes print statements
+  "F841", # Removes unused variables
+]
+exclude = []
+flake8-unused-arguments.ignore-variadic-names = true
+
+[tool.ruff.flake8-tidy-imports.banned-api]
+"typing.Callable".msg = "Use collections.abc.Callable instead."
+"typing.Iterator".msg = "Use collections.abc.Iterator instead."
+"typing.Mapping".msg = "Use collections.abc.Mapping instead."
+"typing.Sequence".msg = "Use collections.abc.Sequence instead."
+"typing.Set".msg = "Use collections.abc.Set instead."
+"importlib.abc".msg = "Use sp_repo_review._compat.importlib.resources.abc instead."
+"importlib.resources.abc".msg = "Use sp_repo_review._compat.importlib.resources.abc instead."
+
+[tool.ruff.per-file-ignores]
+"src/sp_repo_review/_compat/**.py" = ["TID251"]

src/sp_repo_review/__init__.py

@@ -0,0 +1,12 @@
+"""
+Copyright (c) 2022 Henry Schreiner. All rights reserved.
+
+sp-repo-review: Review repos with a set of checks defined by plugins.
+"""
+
+
+from __future__ import annotations
+
+__version__ = "2023.06.01"
+
+__all__ = ["__version__"]

src/sp_repo_review/_compat/__init__.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+import sys
+
+if sys.version_info < (3, 11):
+    from importlib.abc import Traversable
+else:
+    from importlib.resources.abc import Traversable
+
+
+__all__ = ["Traversable"]
+
+
+def __dir__() -> list[str]:
+    return __all__

src/sp_repo_review/_compat/importlib/__init__.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+import sys
+
+if sys.version_info < (3, 11):
+    from tomli import load, loads
+else:
+    from tomllib import load, loads
+
+__all__ = ["load", "loads"]
+
+
+def __dir__() -> list[str]:
+    return __all__