feature: Implement keyring support to store deepl API key

Author: JanEbbing

.gitlab-ci.yml

@@ -3,7 +3,10 @@ include:
   - project: '${CI_PROJECT_NAMESPACE}/ci-libs-for-client-libraries'
     file:
       - '/${CI_PROJECT_NAME}/.gitlab-ci.yml'
-      
+  - project: 'deepl/ops/ci-cd-infrastructure/gitlab-ci-lib'
+    file:
+      - '/templates/.buildkit.yml'
+
 # Global --------------------------
 
 image: python:3.11
@@ -13,7 +16,7 @@ variables:
   XDG_CACHE_HOME: "${CI_PROJECT_DIR}/.cache"
   POETRY_VIRTUALENVS_IN_PROJECT: "true"
   REQUESTS_CA_BUNDLE: "/etc/ssl/certs/ca-certificates.crt"
-  
+
 cache:
   key:
     prefix: ${CI_JOB_IMAGE}
@@ -30,6 +33,7 @@ stages:
   - test
   - publish
 
+
 before_script:
   - python3 -m venv .venv
   - source .venv/bin/activate
@@ -140,4 +144,4 @@ pypi upload:
   rules:
     - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'
   script:
-    - poetry publish --verbose --no-interaction
+    - poetry publish --verbose --no-interaction

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 * Add [example script](examples/mustache) to translate Mustache templates.
+* Add support for storing your API Key in a keyring via the `keyring` module.
 ### Changed
 ### Deprecated
 ### Removed

README.md

@@ -491,14 +491,16 @@ python3 -m deepl --help
 ```
 
 The CLI requires your DeepL authentication key specified either as the
-`DEEPL_AUTH_KEY` environment variable, or using the `--auth-key` option, for
-example:
+`DEEPL_AUTH_KEY` environment variable, through the `keyring` module, or
+using the `--auth-key` option, for example:
 
 ```shell
 python3 -m deepl --auth-key=YOUR_AUTH_KEY usage
 ```
 
 Note that the `--auth-key` argument must appear *before* the command argument.
+To use the [keyring](https://pypi.org/project/keyring/) module, set the 
+*DEEPL_AUTH_KEY* field in the service *deepl* to your API key.
 The recognized commands are:
 
 | Command   | Description                                            |

deepl/__main__.py

@@ -9,6 +9,7 @@
 import pathlib
 import sys
 from typing import List
+from deepl.util import _optional_import
 
 # Program name for integration with click.testing
 name = "python -m deepl"
@@ -17,6 +18,9 @@
 env_server_url = "DEEPL_SERVER_URL"
 env_proxy_url = "DEEPL_PROXY_URL"
 
+keyring_key_folder = "deepl"
+keyring_key_name = env_auth_key
+
 
 def action_usage(translator: deepl.Translator):
     """Action function for the usage command."""
@@ -208,7 +212,9 @@ def get_parser(prog_name):
         "--auth-key",
         default=None,
         help="authentication key as given in your DeepL account; the "
-        f"{env_auth_key} environment variable is used as secondary fallback",
+        f"{env_auth_key} environment variable is used as secondary fallback; "
+        f"the key {keyring_key_name} in {keyring_key_folder} is used "
+        "as tertiary fallback",
     )
     parser.add_argument(
         "--server-url",
@@ -500,14 +506,26 @@ def main(args=None, prog_name=None):
         logger.setLevel(logging.WARNING)
 
     server_url = args.server_url or os.getenv(env_server_url)
-    auth_key = args.auth_key or os.getenv(env_auth_key)
     proxy_url = args.proxy_url or os.getenv(env_proxy_url)
 
+    auth_key = args.auth_key or os.getenv(env_auth_key)
+    keyring = _optional_import("keyring")
+    if keyring:
+        keyring_pw = None
+        try:
+            keyring_pw = keyring.get_password(
+                keyring_key_folder, keyring_key_name
+            )
+        except keyring.errors.NoKeyringError:
+            pass
+        auth_key = auth_key or keyring_pw
+
     try:
         if auth_key is None:
             raise Exception(
                 f"Please provide authentication key via the {env_auth_key} "
-                "environment variable or --auth_key argument"
+                "environment variable or --auth_key argument or via "
+                f"{keyring_key_name} in {keyring_key_folder} in keyring"
             )
 
         # Note: the get_languages() call to verify language codes is skipped

deepl/util.py

@@ -1,13 +1,36 @@
 # Copyright 2022 DeepL SE (https://www.deepl.com)
 # Use of this source code is governed by an MIT
 # license that can be found in the LICENSE file.
+import importlib
 import itertools
 import logging
 from typing import Dict, Optional
 
 logger = logging.getLogger("deepl")
 
 
+def _optional_import(module_name: str):
+    """Tries importing the specified module and returns it if successful,
+    else None.
+    Example:
+
+    keyring = _optional_import('keyring')
+    if keyring:
+        keyring.get_password(...)
+    else:
+        # Code to handle the module not being present
+        pass
+
+    :param module_name: str containing the exact module name
+    :return: The module, if the import was successful, or None
+    """
+    try:
+        module = importlib.import_module(module_name)
+        return module
+    except ImportError:
+        return None
+
+
 def _get_log_text(message, **kwargs):
     return (
         message