Add diagnose command. Fixes #633.

CHANGES.rst

@@ -1,3 +1,8 @@
+v24.1.0
+-------
+
+* #633: Added ``diagnose`` command with basic support.
+
 v24.0.0
 -------
 

README.rst

@@ -146,14 +146,7 @@ Config file path
 
 The configuration is stored in a file named "keyringrc.cfg"
 found in a platform-specific location. To determine
-where the config file is stored, run the following::
-
-    python -c "import keyring.util.platform_; print(keyring.util.platform_.config_root())"
-
-Some keyrings also store the keyring data in the file system.
-To determine where the data files are stored, run::
-
-    python -c "import keyring.util.platform_; print(keyring.util.platform_.data_root())"
+where the config file is stored, run ``keyring diagnose``.
 
 Config file content
 -------------------

keyring/cli.py

@@ -9,6 +9,7 @@
 from . import backend
 from . import completion
 from . import set_keyring, get_password, set_password, delete_password
+from .util import platform_
 
 
 class CommandLineTool:
@@ -38,7 +39,7 @@ def __init__(self):
         )
         self.parser.add_argument(
             'operation',
-            choices=["get", "set", "del"],
+            choices=["get", "set", "del", "diagnose"],
             nargs="?",
         )
         self.parser.add_argument(
@@ -64,6 +65,10 @@ def run(self, argv):
             core.disable()
             return
 
+        if args.operation == 'diagnose':
+            self.diagnose()
+            return
+
         self._check_args()
         self._load_spec_backend()
         method = getattr(self, f'do_{self.operation}', self.invalid_op)
@@ -89,6 +94,14 @@ def do_set(self):
     def do_del(self):
         delete_password(self.service, self.username)
 
+    def diagnose(self):
+        config_root = core._config_path()
+        if config_root.exists():
+            print("config path:", config_root)
+        else:
+            print("config path:", config_root, "(absent)")
+        print("data root:", platform_.data_root())
+
     def invalid_op(self):
         self.parser.error("Specify operation 'get', 'del', or 'set'.")