devopsdriver 0.1.32__tar.gz → 0.1.34__tar.gz

{devopsdriver-0.1.32 → devopsdriver-0.1.34}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devopsdriver
-Version: 0.1.32
+Version: 0.1.34
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -43,12 +43,14 @@ Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
 Classifier: Topic :: Software Development
-Requires-Python: >=3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
+Requires-Dist: keyring==25.0.0
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=starting...&color=inactive&style=plastic)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.34&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.34/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![commit sheild](https://img.shields.io/github/last-commit/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/commits)
 [![activity sheild](https://img.shields.io/github/commit-activity/m/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/commits)

{devopsdriver-0.1.32 → devopsdriver-0.1.34}/README.md

@@ -1,4 +1,5 @@
 ![status sheild](https://img.shields.io/static/v1?label=status&message=starting...&color=inactive&style=plastic)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.34&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.34/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![commit sheild](https://img.shields.io/github/last-commit/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/commits)
 [![activity sheild](https://img.shields.io/github/commit-activity/m/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/commits)

{devopsdriver-0.1.32 → devopsdriver-0.1.34}/devopsdriver/__init__.py

@@ -1,5 +1,5 @@
 """ DevOps tools """
 
-__version__ = "0.1.32"
+__version__ = "0.1.34"
 __author__ = "Marc Page"
 __credits__ = ""

{devopsdriver-0.1.32 → devopsdriver-0.1.34}/devopsdriver/settings.py

@@ -82,9 +82,10 @@ from os import environ as os_environ, makedirs as os_makedirs
 from re import compile as regex
 from platform import system as os_system
 from sys import argv as sys_argv
+from getpass import getpass as os_getpass
 
 from yaml import safe_load
-
+from keyring import get_password, set_password
 
 # for testing
 ENVIRON = os_environ
@@ -93,6 +94,9 @@ SYSTEM = os_system
 MAKEDIRS = os_makedirs
 SHARED = "devopsdriver"
 PRINT = print
+GET_PASSWORD = get_password
+SET_PASSWORD = set_password
+GET_PASS = os_getpass
 
 
 def load_json(path: str) -> dict:
@@ -154,6 +158,30 @@ class Settings:
         self.settings = Settings.__find_all_settings(search_info)
         self.opts = {}
         self.environ = {}
+        self.secrets = {}
+
+    def __bypass(self, key: str, name: str, store: dict):
+        if name is None:
+            for setting_key, store_name in self.settings.get(key, {}).items():
+                store[setting_key] = store_name
+            return self
+
+        store[key] = name
+        return self
+
+    def key(self, key: str, name: str = None):
+        """Sets a keychain name to map to a settings value.
+
+        Args:
+            key (str): The settings key it maps to, dotted for inside dictionary
+            name (str): Name of the keychain key
+                            If name is not specified, the key is a settings value
+                            to lookup up the mappings for keys to switches
+
+        Returns:
+            Settings: Returns self so you can chain calls
+        """
+        return self.__bypass(key, name, self.secrets)
 
     def cli(self, key: str, name: str = None):
         """Sets a command line switch to map to a settings value.
@@ -167,13 +195,7 @@ class Settings:
         Returns:
             Settings: Returns self so you can chain calls
         """
-        if name is None:
-            for setting_key, env_name in self.settings.get(key, {}).items():
-                self.opts[setting_key] = env_name
-            return self
-
-        self.opts[key] = name
-        return self
+        return self.__bypass(key, name, self.opts)
 
     def env(self, key: str, name: str = None):
         """Sets an environment variable to map to a settings value.
@@ -187,13 +209,7 @@ class Settings:
         Returns:
             Settings: Returns self so you can chain calls
         """
-        if name is None:
-            for setting_key, cli_name in self.settings.get(key, {}).items():
-                self.environ[setting_key] = cli_name
-            return self
-
-        self.environ[key] = name
-        return self
+        return self.__bypass(key, name, self.environ)
 
     @staticmethod
     def __patch_instance(key: str) -> str:
@@ -212,6 +228,23 @@ class Settings:
 
         return value
 
+    @staticmethod
+    def split_key(key: str) -> tuple[str, str]:
+        """Splits a keychain name into service and name
+
+        Args:
+            key (str): If there is a / then it is service/name
+                        otherwise it is "system"/name
+
+        Returns:
+            tuple[str, str]: The service and name
+        """
+        parts = key.split("/", 1)
+        assert len(parts) in {1, 2}, parts
+        service = parts[0] if len(parts) == 2 else "system"
+        secret_name = parts[1] if len(parts) == 2 else parts[0]
+        return (service, secret_name)
+
     def __lookup(self, key: str, check: bool, default: any = None) -> any:
         # Settings passed in override everything
         if key in self.overrides:
@@ -229,6 +262,13 @@ class Settings:
                 if e_key.lower() == self.environ[key].lower():
                     return True if check else ENVIRON[e_key]
 
+        # Settings in the keychain are next
+        if key in self.secrets:
+            value = GET_PASSWORD(*Settings.split_key(self.secrets[key]))
+
+            if value is not None:
+                return True if check else value
+
         # Last check the files for settings
         keys = key.split(".")
         level = self.settings
@@ -318,9 +358,21 @@ class Settings:
 
 def main() -> None:
     """Get settings values"""
-    settings = Settings(__file__, dirname(dirname(__file__)))
+    settings = Settings(__file__, dirname(dirname(__file__))).key("secrets")
+
+    args = list(ARGV[1:])
+
+    if "--set_secrets" in args:
+        args.remove("--set_secrets")
+
+        for secret, key in settings.secrets.items():
+            if not settings.has(secret):
+                value = GET_PASS(f"{secret} ({key}): ")
+
+                if value:
+                    SET_PASSWORD(*Settings.split_key(key), value)
 
-    for arg in ARGV[1:]:
+    for arg in args:
         PRINT(settings.get(arg))
 
 

{devopsdriver-0.1.32 → devopsdriver-0.1.34}/devopsdriver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devopsdriver
-Version: 0.1.32
+Version: 0.1.34
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -43,12 +43,14 @@ Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Utilities
 Classifier: Topic :: Software Development
-Requires-Python: >=3.12
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.1
+Requires-Dist: keyring==25.0.0
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=starting...&color=inactive&style=plastic)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.34&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.34/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![commit sheild](https://img.shields.io/github/last-commit/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/commits)
 [![activity sheild](https://img.shields.io/github/commit-activity/m/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver/commits)

devopsdriver-0.1.34/devopsdriver.egg-info/requires.txt

@@ -0,0 +1,2 @@
+PyYAML==6.0.1
+keyring==25.0.0

{devopsdriver-0.1.32 → devopsdriver-0.1.34}/pyproject.toml

@@ -4,9 +4,10 @@ description = "DevOps tools"
 readme = "README.md"
 license = {file = "LICENSE"}
 dynamic = ["version"]
-requires-python = ">= 3.12"
+requires-python = ">= 3.10"
 dependencies = [
   "PyYAML==6.0.1",
+  "keyring==25.0.0",
 ]
 keywords = ["azure", "devops", "jira", "confluence", "email", "pipelines", "tools"]
 classifiers=[

{devopsdriver-0.1.32 → devopsdriver-0.1.34}/tests/test_settings.py

@@ -20,6 +20,9 @@ def __setup_settings(os: str = "Linux", shared: str = "test", **pref_dirs) -> No
     settings.SYSTEM = lambda: os
     settings.SHARED = shared
     settings.PRINT = lambda s: s
+    settings.GET_PASSWORD = lambda s, n: f"{s}:{n}"
+    settings.GET_PASS = lambda p: p
+    settings.SET_PASSWORD = lambda s, n, p: f"{s} {n} {p}"
     # settings.MAKEDIRS = lambda p: p
     # settings.Settings.FORMATS = None
     settings.Settings.PREF_DIR = pref_dirs
@@ -292,7 +295,48 @@ def test_main():
         settings.main()
 
 
+def test_secret():
+    """test os secret storage"""
+    with TemporaryDirectory() as working_dir:
+        base_dir = join(working_dir, "base")
+        passwords = {"system": {"john": "setec astronomy"}}
+        __setup_settings(
+            os="Linux",
+            shared="test",
+            Linux=join(base_dir, "Linux"),
+            Darwin=join(base_dir, "macOS"),
+            Windows=join(base_dir, "Windows"),
+        )
+        settings.GET_PASSWORD = lambda s, e: passwords.get(s, {}).get(e, None)
+        __write(join(base_dir, "main.yml"), password="main")
+        opts = settings.Settings(join(base_dir, "main.py")).key(
+            "password", "system/john"
+        )
+        assert opts["password"] == "setec astronomy", opts["password"]
+
+
+def test_main_set_secret():
+    """test the main entry point when settings keychain secrets"""
+
+    def set_password(s, n, p):
+        assert s == "azure" and n == "token" and p == "setec astronomy", f"{s} {n} {p}"
+
+    with TemporaryDirectory() as working_dir:
+        __setup_settings(shared="test", Linux=join(working_dir, "Linux"))
+        settings.ARGV = ["ignore", "--set_secrets"]
+        settings.GET_PASSWORD = lambda s, n: None
+        settings.GET_PASS = lambda p: "setec astronomy"
+        settings.SET_PASSWORD = set_password
+        __write(
+            join(working_dir, "Linux", "test.yml"),
+            secrets={"azure.token": "azure/token"},
+        )
+        settings.main()
+
+
 if __name__ == "__main__":
+    test_main_set_secret()
+    test_secret()
     test_main()
     test_environ_values()
     test_cli_env_in_yaml()

devopsdriver-0.1.32/devopsdriver.egg-info/requires.txt

@@ -1 +0,0 @@
-PyYAML==6.0.1