.coveragerc

@@ -7,3 +7,9 @@ disable_warnings =
 
 [report]
 show_missing = True
+exclude_also =
+	# Exclude common false positives per
+	# https://coverage.readthedocs.io/en/latest/excluding.html#advanced-exclusion
+	# Ref jaraco/skeleton#97 and jaraco/skeleton#135
+	class .*\bProtocol\):
+	if TYPE_CHECKING:

.github/workflows/main.yml

@@ -1,96 +1,105 @@
 name: tests
 
-on: [push, pull_request]
+on:
+  merge_group:
+  push:
+    branches-ignore:
+    # temporary GH branches relating to merge queues (jaraco/skeleton#93)
+    - gh-readonly-queue/**
+    tags:
+    # required if branches-ignore is supplied (jaraco/skeleton#103)
+    - '**'
+  pull_request:
+  workflow_dispatch:
 
 permissions:
   contents: read
 
 env:
-  # Environment variables to support color support (jaraco/skeleton#66):
-  # Request colored output from CLI tools supporting it. Different tools
-  # interpret the value differently. For some, just being set is sufficient.
-  # For others, it must be a non-zero integer. For yet others, being set
-  # to a non-empty value is sufficient. For tox, it must be one of
-  # <blank>, 0, 1, false, no, off, on, true, yes. The only enabling value
-  # in common is "1".
+  # Environment variable to support color support (jaraco/skeleton#66)
   FORCE_COLOR: 1
-  # MyPy's color enforcement (must be a non-zero number)
-  MYPY_FORCE_COLOR: -42
-  # Recognized by the `py` package, dependency of `pytest` (must be "1")
-  PY_COLORS: 1
-  # Make tox-wrapped tools see color requests
-  TOX_TESTENV_PASSENV: >-
-    FORCE_COLOR
-    MYPY_FORCE_COLOR
-    NO_COLOR
-    PY_COLORS
-    PYTEST_THEME
-    PYTEST_THEME_MODE
 
   # Suppress noisy pip warnings
   PIP_DISABLE_PIP_VERSION_CHECK: 'true'
   PIP_NO_PYTHON_VERSION_WARNING: 'true'
   PIP_NO_WARN_SCRIPT_LOCATION: 'true'
 
-  # Disable the spinner, noise in GHA; TODO(webknjaz): Fix this upstream
-  # Must be "1".
-  TOX_PARALLEL_NO_SPINNER: 1
+  # Ensure tests can sense settings about the environment
+  TOX_OVERRIDE: >-
+    testenv.pass_env+=GITHUB_*,FORCE_COLOR
 
 
 jobs:
   test:
     strategy:
+      # https://blog.jaraco.com/efficient-use-of-ci-resources/
       matrix:
         python:
-        - "3.8"
-        - "3.11"
-        - "3.12"
+        - "3.9"
+        - "3.13"
         platform:
         - ubuntu-latest
         - macos-latest
         - windows-latest
         include:
-        - python: "3.9"
-          platform: ubuntu-latest
         - python: "3.10"
           platform: ubuntu-latest
-        - python: pypy3.9
+        - python: "3.11"
+          platform: ubuntu-latest
+        - python: "3.12"
+          platform: ubuntu-latest
+        - python: "3.14"
+          platform: ubuntu-latest
+        - python: pypy3.10
           platform: ubuntu-latest
     runs-on: ${{ matrix.platform }}
-    continue-on-error: ${{ matrix.python == '3.12' }}
+    continue-on-error: ${{ matrix.python == '3.14' }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+      - name: Install build dependencies
+        # Install dependencies for building packages on pre-release Pythons
+        # jaraco/skeleton#161
+        if: matrix.python == '3.14' && matrix.platform == 'ubuntu-latest'
+        run: |
+          sudo apt update
+          sudo apt install -y libxml2-dev libxslt-dev
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python }}
           allow-prereleases: true
       - name: Install tox
-        run: |
-          python -m pip install tox
+        run: python -m pip install tox
       - name: Run
         run: tox
 
-  docs:
+  collateral:
+    strategy:
+      fail-fast: false
+      matrix:
+        job:
+        - diffcov
+        - docs
     runs-on: ubuntu-latest
-    env:
-      TOXENV: docs
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Setup Python
         uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
       - name: Install tox
-        run: |
-          python -m pip install tox
-      - name: Run
-        run: tox
+        run: python -m pip install tox
+      - name: Eval ${{ matrix.job }}
+        run: tox -e ${{ matrix.job }}
 
   check:  # This job does nothing and is only used for the branch protection
     if: always()
 
     needs:
     - test
-    - docs
+    - collateral
 
     runs-on: ubuntu-latest
 
@@ -109,14 +118,13 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
           python-version: 3.x
       - name: Install tox
-        run: |
-          python -m pip install tox
+        run: python -m pip install tox
       - name: Run
         run: tox -e release
         env:

.pre-commit-config.yaml

@@ -1,5 +1,7 @@
 repos:
-- repo: https://github.com/psf/black
-  rev: 22.6.0
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.7.1
   hooks:
-  - id: black
+  - id: ruff
+    args: [--fix, --unsafe-fixes]
+  - id: ruff-format

.readthedocs.yaml

@@ -3,10 +3,17 @@ python:
   install:
   - path: .
     extra_requirements:
-      - docs
+      - doc
+
+sphinx:
+  configuration: docs/conf.py
 
 # required boilerplate readthedocs/readthedocs.org#10401
 build:
-  os: ubuntu-22.04
+  os: ubuntu-lts-latest
   tools:
-    python: "3"
+    python: latest
+  # post-checkout job to ensure the clone isn't shallow jaraco/skeleton#114
+  jobs:
+    post_checkout:
+    - git fetch --unshallow || true

NEWS.rst

@@ -1,3 +1,118 @@
+v25.6.0
+=======
+
+Features
+--------
+
+- Avoid logging a warning when config does not specify a backend. (#682)
+
+
+v25.5.0
+=======
+
+Features
+--------
+
+- When parsing ``keyring_path`` from the config, the home directory is now expanded from ``~``. (#696)
+
+
+Bugfixes
+--------
+
+- In get_credential, now returns None when the indicated username is not found. (#698)
+
+
+v25.4.1
+=======
+
+Bugfixes
+--------
+
+- Fixed ValueError for AnonymousCredentials in CLI. (#694)
+
+
+v25.4.0
+=======
+
+Features
+--------
+
+- Refined type spec and interfaces on credential objects. Introduced AnonymousCredential to model a secret without a username. (#689)
+
+
+v25.3.0
+=======
+
+Features
+--------
+
+- Deprecated support for empty usernames. Now all backends will reject an empty string as input for the 'username' field when setting a password. Later this deprecation will become a more visible user warning and even later an error. If this warning is triggered in your environment, please consider using a static value (even 'username') or comment in the issue and describe the use-case that demands support for empty usernames. (#668)
+
+
+v25.2.1
+=======
+
+Bugfixes
+--------
+
+- Fix typo in CLI creds mode. (#681)
+
+
+v25.2.0
+=======
+
+Features
+--------
+
+- Added options for 'keyring get' command to support credential retrieval and emit as JSON. (#678)
+
+
+v25.1.0
+=======
+
+Features
+--------
+
+- Replace ExceptionRaisedContext with ExceptionTrap.
+
+
+v25.0.1
+=======
+
+Bugfixes
+--------
+
+- When completion is unavailable, exit with non-zero status and emit message to stderr. (#671)
+
+
+v25.0.0
+=======
+
+Deprecations and Removals
+-------------------------
+
+- Removed check for config in XDG_DATA_HOME on Linux systems. (#99)
+- In platform config support, remove support for Windows XP, now 10 years sunset.
+
+
+v24.3.1
+=======
+
+Bugfixes
+--------
+
+- Minor fixes to account for emergent typing and linter concerns.
+
+
+v24.3.0
+=======
+
+Features
+--------
+
+- Added bash completion support. (#643)
+
+
 v24.2.0
 =======
 
@@ -416,7 +531,7 @@ v19.3.0
   of ``PasswordSetError`` or ``KeyringError``. Any API users
   may need to account for this change, probably by catching
   the parent ``KeyringError``.
-  Additionally, the error message from the underying error is
+  Additionally, the error message from the underlying error is
   now included in any errors that occur.
 
 17.1.1