.github/workflows/main.yml

@@ -31,6 +31,7 @@ env:
 jobs:
   test:
     strategy:
+      # https://blog.jaraco.com/efficient-use-of-ci-resources/
       matrix:
         python:
         - "3.8"
@@ -49,7 +50,7 @@ jobs:
         - python: pypy3.10
           platform: ubuntu-latest
     runs-on: ${{ matrix.platform }}
-    continue-on-error: ${{ matrix.python == '3.13' }}
+    continue-on-error: ${{ matrix.python == '3.13' || (matrix.python == '3.8' || matrix.python == '3.9') && matrix.platform == 'macos-latest' }}
     steps:
       - uses: actions/checkout@v4
       - name: Setup Python

NEWS.rst

@@ -1,3 +1,12 @@
+v25.2.0
+=======
+
+Features
+--------
+
+- Added options for 'keyring get' command to support credential retrieval and emit as JSON. (#678)
+
+
 v25.1.0
 =======
 

keyring/cli.py

@@ -1,17 +1,22 @@
 """Simple command line interface to get/set password from a keyring"""
 
+from __future__ import annotations
+
 import argparse
 import getpass
+import json
 import sys
 
 from . import (
     backend,
     completion,
     core,
+    credentials,
     delete_password,
     get_password,
     set_keyring,
     set_password,
+    get_credential,
 )
 from .util import platform_
 
@@ -41,6 +46,32 @@ def __init__(self):
         self.parser.add_argument(
             "--disable", action="store_true", help="Disable keyring and exit"
         )
+        self.parser._get_modes = ["password", "creds"]
+        self.parser.add_argument(
+            "--mode",
+            choices=self.parser._get_modes,
+            dest="get_mode",
+            default="password",
+            help="""
+            Mode for 'get' operation.
+            'password' requires a username and will return only the password.
+            'creds' does not require a username and will return both the username and password separated by a newline.
+
+            Default is 'password'
+            """,
+        )
+        self.parser._output_formats = ["plain", "json"]
+        self.parser.add_argument(
+            "--output",
+            choices=self.parser._output_formats,
+            dest="output_format",
+            default="plain",
+            help="""
+            Output format for 'get' operation.
+
+            Default is 'plain'
+            """,
+        )
         self.parser._operations = ["get", "set", "del", "diagnose"]
         self.parser.add_argument(
             'operation',
@@ -80,15 +111,37 @@ def run(self, argv):
         return method()
 
     def _check_args(self):
-        if self.operation:
-            if self.service is None or self.username is None:
-                self.parser.error(f"{self.operation} requires service and username")
+        needs_username = self.operation != 'get' or self.get_mode != 'creds'
+        required = (['service'] + ['username'] * needs_username) * bool(self.operation)
+        if any(getattr(self, param) is None for param in required):
+            self.parser.error(f"{self.operation} requires {' and '.join(required)}")
 
     def do_get(self):
-        password = get_password(self.service, self.username)
-        if password is None:
+        credential = getattr(self, f'_get_{self.get_mode}')()
+        if credential is None:
             raise SystemExit(1)
-        print(password)
+        getattr(self, f'_emit_{self.output_format}')(credential)
+
+    def _emit_json(self, credential: credentials.Credential):
+        print(
+            json.dumps(dict(username=credential.username, password=credential.password))
+        )
+
+    def _emit_plain(self, credential: credentials.Credential):
+        if credential.username:
+            print(credential.username)
+        print(credential.password)
+
+    def _get_cred(self) -> credentials.Credential | None:
+        return get_credential(self.service, self.username)  # type: ignore
+
+    def _get_password(self) -> credentials.Credential | None:
+        password = get_password(self.service, self.username)  # type: ignore
+        return (
+            credentials.SimpleCredential(None, password)
+            if password is not None
+            else None
+        )
 
     def do_set(self):
         password = self.input_password(

pyproject.toml

@@ -1,5 +1,79 @@
 [build-system]
-requires = ["setuptools>=56", "setuptools_scm[toml]>=3.4.1"]
+requires = ["setuptools>=61.2", "setuptools_scm[toml]>=3.4.1"]
 build-backend = "setuptools.build_meta"
 
+[project]
+name = "keyring"
+authors = [
+	{ name = "Kang Zhang", email = "jobo.zh@gmail.com" },
+]
+maintainers = [
+	{ name = "Jason R. Coombs", email = "jaraco@jaraco.com" },
+]
+description = "Store and access your passwords safely."
+readme = "README.rst"
+classifiers = [
+	"Development Status :: 5 - Production/Stable",
+	"Intended Audience :: Developers",
+	"License :: OSI Approved :: MIT License",
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3 :: Only",
+]
+requires-python = ">=3.8"
+dependencies = [
+	'pywin32-ctypes>=0.2.0; sys_platform=="win32"',
+	'SecretStorage>=3.2; sys_platform=="linux"',
+	'jeepney>=0.4.2; sys_platform=="linux"',
+	'importlib_metadata >= 4.11.4; python_version < "3.12"',
+	"jaraco.classes",
+	'importlib_resources; python_version < "3.9"',
+	"jaraco.functools",
+	"jaraco.context",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/jaraco/keyring"
+
+[project.optional-dependencies]
+testing = [
+	# upstream
+	"pytest >= 6, != 8.1.*",
+	"pytest-checkdocs >= 2.4",
+	"pytest-cov",
+	"pytest-mypy",
+	"pytest-enabler >= 2.2",
+	"pytest-ruff >= 0.2.1",
+
+	# local
+]
+docs = [
+	# upstream
+	"sphinx >= 3.5",
+	"jaraco.packaging >= 9.3",
+	"rst.linker >= 1.9",
+	"furo",
+	"sphinx-lint",
+
+	# tidelift
+	"jaraco.tidelift >= 1.4",
+
+	# local
+]
+completion = ["shtab >= 1.1.0"]
+
+[project.entry-points]
+devpi_client = {keyring = "keyring.devpi_client"}
+
+[project.entry-points."keyring.backends"]
+Windows = "keyring.backends.Windows"
+macOS = "keyring.backends.macOS"
+libsecret = "keyring.backends.libsecret"
+SecretService = "keyring.backends.SecretService"
+KWallet = "keyring.backends.kwallet"
+chainer = "keyring.backends.chainer"
+
+[project.scripts]
+keyring = "keyring.cli:main"
+
 [tool.setuptools_scm]