CI: repository configuration

Author: dmgav

.pre-commit-config.yaml

@@ -1,91 +1,23 @@
-ci:
-  autoupdate_commit_msg: "chore: update pre-commit hooks"
-  autofix_commit_msg: "style: pre-commit fixes"
-
-exclude: ^.cruft.json|.copier-answers.yml$
-
 repos:
-  - repo: https://github.com/adamchainz/blacken-docs
-    rev: "1.19.1"
-    hooks:
-      - id: blacken-docs
-        additional_dependencies: [black==24.*]
-
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v6.0.0"
+    rev: v5.0.0
     hooks:
       - id: check-added-large-files
-      - id: check-case-conflict
-      - id: check-merge-conflict
-      - id: check-symlinks
       - id: check-yaml
-      - 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/rbubley/mirrors-prettier
-    rev: "v3.6.2"
-    hooks:
-      - id: prettier
-        types_or: [yaml, markdown, html, css, scss, javascript, json]
-        args: [--prose-wrap=always]
-
-  - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.12.12"
-    hooks:
-      - id: ruff-check
-        args: ["--fix", "--show-fixes"]
-      - id: ruff-format
-
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.17.1"
-    hooks:
-      - id: mypy
-        files: src|tests
-        args: []
-        additional_dependencies:
-          - pytest
-
-  - repo: https://github.com/codespell-project/codespell
-    rev: "v2.4.1"
-    hooks:
-      - id: codespell
-        additional_dependencies:
-          - tomli; python_version<'3.11'
-
-  - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: "v0.11.0.1"
-    hooks:
-      - id: shellcheck
+      - id: check-merge-conflict
 
   - repo: local
     hooks:
-      - id: disallow-caps
-        name: Disallow improper capitalization
-        language: pygrep
-        entry: PyBind|Numpy|Cmake|CCache|Github|PyTest
-        exclude: .pre-commit-config.yaml
-
-  - repo: https://github.com/abravalheri/validate-pyproject
-    rev: "v0.24.1"
-    hooks:
-      - id: validate-pyproject
-        additional_dependencies: ["validate-pyproject-schema-store[all]"]
+      - id: ruff
+        name: lint with ruff
+        language: system
+        entry: ruff check --force-exclude --fix
+        types: [python]
+        require_serial: true
 
-  - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: "0.33.3"
-    hooks:
-      - id: check-dependabot
-      - id: check-github-workflows
-      - id: check-readthedocs
+      - id: ruff-format
+        name: format with ruff
+        language: system
+        entry: ruff format --force-exclude
+        types: [python]
+        require_serial: true

noxfile.py

@@ -1,13 +1,10 @@
 [build-system]
-requires = ["setuptools>=77", "setuptools_scm[toml]>=7"]
+requires = ["setuptools>=77", "setuptools_scm[toml]>=8"]
 build-backend = "setuptools.build_meta"
 
 
 [project]
 name = "save-and-restore-api"
-authors = [
-  { name = "My Name", email = "[email protected]" },
-]
 description = "Python package for communication with CS Studio save-and-restore service"
 readme = "README.md"
 license = "BSD-3-Clause"
@@ -18,9 +15,6 @@ classifiers = [
   "Intended Audience :: Science/Research",
   "Intended Audience :: Developers",
   "Operating System :: OS Independent",
-  "Programming Language :: Python",
-  "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3 :: Only",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
@@ -30,14 +24,16 @@ classifiers = [
   "Typing :: Typed",
 ]
 dynamic = ["version"]
-dependencies = []
+
+[project.scripts]
+save-and-restore-upload = "save_and_restore_api.tools.upload:main"
 
 [project.urls]
 Homepage = "https://github.com/dmgav/save-and-restore-api"
-"Bug Tracker" = "https://github.com/dmgav/save-and-restore-api/issues"
-Discussions = "https://github.com/dmgav/save-and-restore-api/discussions"
-Changelog = "https://github.com/dmgav/save-and-restore-api/releases"
 
+dependencies = [
+  "httpx",
+]
 
 [dependency-groups]
 test = [
@@ -62,15 +58,20 @@ write_to = "src/save_and_restore_api/_version.py"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = ["-ra", "--showlocals", "--strict-markers", "--strict-config"]
-xfail_strict = true
+# Run pytest with all our checkers, and don't spam us with massive tracebacks on error
+# Don't collect the interactive directory which is intended for manual execution
+addopts = """
+    --tb=native -vv --doctest-modules --doctest-glob="*.rst" --ignore src/bluesky/tests/interactive
+    """
+# https://iscinumpy.gitlab.io/post/bound-version-constraints/#watch-for-warnings
 filterwarnings = [
-  "error",
-]
-log_cli_level = "INFO"
-testpaths = [
-  "tests",
+    "error",
+    "ignore::PendingDeprecationWarning",
+    "ignore::UserWarning",
+    "ignore::DeprecationWarning",
 ]
+# Doctest python code in docs, python code in src docstrings, test functions in tests
+testpaths = "src/save_and_restore_api/tests"
 
 
 [tool.coverage]
@@ -95,56 +96,31 @@ module = "save_and_restore_api.*"
 disallow_untyped_defs = true
 disallow_incomplete_defs = true
 
-
 [tool.ruff]
+src = ["src", "tests"]
+line-length = 115
+exclude = [
+    "docs/source/conf.py",
+    "docs/source/examples",
+]
 
 [tool.ruff.lint]
 extend-select = [
-  "ARG",      # flake8-unused-arguments
-  "B",        # flake8-bugbear
-  "C4",       # flake8-comprehensions
-  "EM",       # flake8-errmsg
-  "EXE",      # flake8-executable
-  "G",        # flake8-logging-format
-  "I",        # isort
-  "ICN",      # flake8-import-conventions
-  "NPY",      # NumPy specific rules
-  "PD",       # pandas-vet
-  "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
-  "T20",      # flake8-print
-  "UP",       # pyupgrade
-  "YTT",      # flake8-2020
+    "B",   # flake8-bugbear - https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "C4",  # flake8-comprehensions - https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+    "E",   # pycodestyle errors - https://docs.astral.sh/ruff/rules/#error-e
+    "F",   # pyflakes rules - https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "W",   # pycodestyle warnings - https://docs.astral.sh/ruff/rules/#warning-w
+    "I",   # isort - https://docs.astral.sh/ruff/rules/#isort-i
+    "UP",  # pyupgrade - https://docs.astral.sh/ruff/rules/#pyupgrade-up
 ]
 ignore = [
-  "PLR09",    # Too many <...>
-  "PLR2004",  # Magic value used in comparison
 ]
-isort.required-imports = ["from __future__ import annotations"]
-# Uncomment if using a _compat.typing backport
-# typing-modules = ["save_and_restore_api._compat.typing"]
+isort.required-imports = [
+]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/**" = ["T20"]
-"noxfile.py" = ["T20"]
-
-
-[tool.pylint]
-py-version = "3.9"
-ignore-paths = [".*/_version.py"]
-reports.output-format = "colorized"
-similarities.ignore-imports = "yes"
-messages_control.disable = [
-  "design",
-  "fixme",
-  "line-too-long",
-  "missing-module-docstring",
-  "missing-function-docstring",
-  "wrong-import-position",
-]
+# By default, private member access is allowed in tests
+# See https://github.com/DiamondLightSource/python-copier-template/issues/154
+# Remove this line to forbid private member access in tests
+"tests/**/*" = ["SLF001"]