devopsdriver 0.1.46__tar.gz → 0.1.49__tar.gz

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: devopsdriver
-Version: 0.1.46
+Version: 0.1.49
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -47,10 +47,10 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.2
-Requires-Dist: keyring==25.3.0
-Requires-Dist: setuptools==72.1.0
+Requires-Dist: keyring==25.6.0
+Requires-Dist: setuptools==75.8.0
 Requires-Dist: azure-devops==7.1.0b4
-Requires-Dist: Mako==1.3.5
+Requires-Dist: Mako==1.3.10
 Provides-Extra: dev
 Requires-Dist: black>=24.3.0; extra == "dev"
 Requires-Dist: pylint>=3.1.0; extra == "dev"
@@ -58,9 +58,12 @@ Provides-Extra: test
 Requires-Dist: pytest>=8.1.1; extra == "test"
 Requires-Dist: coverage>=7.4.4; extra == "test"
 Provides-Extra: doc
+Dynamic: license-file
+
+# devops-driver
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.46&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.46/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.49&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.49/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
@@ -82,13 +85,11 @@ Provides-Extra: doc
 [![Azure](https://img.shields.io/static/v1?label=&message=Supports%20Microsoft%20Azure&color=blue&style=plastic&logo=microsoftazure)](https://azure.microsoft.com/)
 [![Gmail](https://img.shields.io/static/v1?label=&message=Supports%20Google%20Gmail&color=white&style=plastic&logo=gmail)](https://gmail.com/)
 
-OS: 
+OS:
 [![Windows](https://img.shields.io/static/v1?label=&message=Windows&color=blue&style=plastic&logo=windows)](https://microsoft.com/)
 [![macOS](https://img.shields.io/static/v1?label=&message=macOS&color=white&logoColor=black&style=plastic&logo=apple)](https://apple.com/)
 [![Linux](https://img.shields.io/static/v1?label=&message=Linux&color=seashell&logoColor=black&style=plastic&logo=linux)](https://linux.org/)
 
-# devops-driver
-
 Devops-driver is a collection of tools to help streamline developer's experience and gain insights into various processes.
 
 ## Tools
@@ -107,6 +108,7 @@ To allow seamless work in both pipelines as well as in the development environme
 Say you want a pipeline that looks for User Stories that are newer than 3 days and send out an email.
 
 ### \<platform dependent path\>/devopsdriver.yml
+
 ```yaml
 smtp:
     sender: JohnDoe@company.com
@@ -116,7 +118,7 @@ secrets:
     smtp.password: smtp/password
 ```
 
-This file is in a global place (location varies by OS) and stores information that you may not want in your repository or is specific to development. 
+This file is in a global place (location varies by OS) and stores information that you may not want in your repository or is specific to development.
 
 | Platform | Global Directory       |
 |----------|------------------------|
@@ -127,6 +129,7 @@ This file is in a global place (location varies by OS) and stores information th
 The `secrets` are extra sensative and are stored in the OS keychain.
 
 ### Set secrets in the keychain
+
 ```bash
 $ python3 -m venv .venv
 $ source .venv/bin/activate
@@ -138,16 +141,21 @@ secret: azure.token  key: azure/token
 smtp.password (azure/token): ****
 $ settings --secrets
 secret: azure.token  key: azure/token
-	Value set
+    Value set
 secret: smtp.password  key: smtp/password
-	Value set
+    Value set
 $
 ```
+
 The first call to `settings` will look for every secret and check if they are already set in the keychain.
 For any secret that has not been set in the keychain, you will be prompted to enter the password to store.
 The second call to `settings` will verify that all the values have been set in the keychain.
 
+**Note**: If your `secrets`, `cli`, or `env` are in a yaml file named after your script,
+you can call `settings --secrets --script my_script.py`.
+
 ### devopsdriver.yml
+
 ```yaml
 azure:
     url: https://dev.azure.com/MyCompany
@@ -173,15 +181,18 @@ The `cli` and `env` map command line switches and environment variables to those
 This allows for many options for setting values depending on your needs.
 
 ### new_stories.yml
+
 ```yaml
 scrum masters:
     - JohnDoe@company.com
     - JaneDoe@company.com
 ```
+
 This file is specific to your script and not shared.
 These are values that you want to use in your script but have them here for easy adjustment.
 
 ### new_stories.html.mako
+
 ```html
 <h1>Stories created in the last ${days} days</h1>
 <ul>
@@ -194,6 +205,7 @@ These are values that you want to use in your script but have them here for easy
 This file is the template for the email body.
 
 ### new_stories.py
+
 ```python
 from datetime import date, timedelta
 
@@ -229,9 +241,9 @@ send_email(
 
 ### The email sent
 
-**From**: JohnDoe@company.com
+**From**: `JohnDoe@company.com`
 
-**To**: JohnDoe@company.com, JaneDoe@company.com
+**To**: `JohnDoe@company.com`, `JaneDoe@company.com`
 
 **Subject**: Stories created in the last 3 days
 
@@ -246,4 +258,3 @@ send_email(
 - 754 frontend - store to schema
 - 755 Transfer job to production. Setup migrations to move to production
 - 756 Query subscription status from App
-

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/README.md

@@ -1,5 +1,7 @@
+# devops-driver
+
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.46&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.46/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.49&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.49/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
@@ -21,13 +23,11 @@
 [![Azure](https://img.shields.io/static/v1?label=&message=Supports%20Microsoft%20Azure&color=blue&style=plastic&logo=microsoftazure)](https://azure.microsoft.com/)
 [![Gmail](https://img.shields.io/static/v1?label=&message=Supports%20Google%20Gmail&color=white&style=plastic&logo=gmail)](https://gmail.com/)
 
-OS: 
+OS:
 [![Windows](https://img.shields.io/static/v1?label=&message=Windows&color=blue&style=plastic&logo=windows)](https://microsoft.com/)
 [![macOS](https://img.shields.io/static/v1?label=&message=macOS&color=white&logoColor=black&style=plastic&logo=apple)](https://apple.com/)
 [![Linux](https://img.shields.io/static/v1?label=&message=Linux&color=seashell&logoColor=black&style=plastic&logo=linux)](https://linux.org/)
 
-# devops-driver
-
 Devops-driver is a collection of tools to help streamline developer's experience and gain insights into various processes.
 
 ## Tools
@@ -46,6 +46,7 @@ To allow seamless work in both pipelines as well as in the development environme
 Say you want a pipeline that looks for User Stories that are newer than 3 days and send out an email.
 
 ### \<platform dependent path\>/devopsdriver.yml
+
 ```yaml
 smtp:
     sender: JohnDoe@company.com
@@ -55,7 +56,7 @@ secrets:
     smtp.password: smtp/password
 ```
 
-This file is in a global place (location varies by OS) and stores information that you may not want in your repository or is specific to development. 
+This file is in a global place (location varies by OS) and stores information that you may not want in your repository or is specific to development.
 
 | Platform | Global Directory       |
 |----------|------------------------|
@@ -66,6 +67,7 @@ This file is in a global place (location varies by OS) and stores information th
 The `secrets` are extra sensative and are stored in the OS keychain.
 
 ### Set secrets in the keychain
+
 ```bash
 $ python3 -m venv .venv
 $ source .venv/bin/activate
@@ -77,16 +79,21 @@ secret: azure.token  key: azure/token
 smtp.password (azure/token): ****
 $ settings --secrets
 secret: azure.token  key: azure/token
-	Value set
+    Value set
 secret: smtp.password  key: smtp/password
-	Value set
+    Value set
 $
 ```
+
 The first call to `settings` will look for every secret and check if they are already set in the keychain.
 For any secret that has not been set in the keychain, you will be prompted to enter the password to store.
 The second call to `settings` will verify that all the values have been set in the keychain.
 
+**Note**: If your `secrets`, `cli`, or `env` are in a yaml file named after your script,
+you can call `settings --secrets --script my_script.py`.
+
 ### devopsdriver.yml
+
 ```yaml
 azure:
     url: https://dev.azure.com/MyCompany
@@ -112,15 +119,18 @@ The `cli` and `env` map command line switches and environment variables to those
 This allows for many options for setting values depending on your needs.
 
 ### new_stories.yml
+
 ```yaml
 scrum masters:
     - JohnDoe@company.com
     - JaneDoe@company.com
 ```
+
 This file is specific to your script and not shared.
 These are values that you want to use in your script but have them here for easy adjustment.
 
 ### new_stories.html.mako
+
 ```html
 <h1>Stories created in the last ${days} days</h1>
 <ul>
@@ -133,6 +143,7 @@ These are values that you want to use in your script but have them here for easy
 This file is the template for the email body.
 
 ### new_stories.py
+
 ```python
 from datetime import date, timedelta
 
@@ -168,9 +179,9 @@ send_email(
 
 ### The email sent
 
-**From**: JohnDoe@company.com
+**From**: `JohnDoe@company.com`
 
-**To**: JohnDoe@company.com, JaneDoe@company.com
+**To**: `JohnDoe@company.com`, `JaneDoe@company.com`
 
 **Subject**: Stories created in the last 3 days
 
@@ -185,4 +196,3 @@ send_email(
 - 754 frontend - store to schema
 - 755 Transfer job to production. Setup migrations to move to production
 - 756 Query subscription status from App
-

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/__init__.py

@@ -1,4 +1,4 @@
-""" DevOps tools """
+"""DevOps tools"""
 
 from .settings import Settings
 from .sendmail import send_email
@@ -6,6 +6,6 @@ from .template import Template
 from .azdo.clients import Azure
 
 
-__version__ = "0.1.46"
+__version__ = "0.1.49"
 __author__ = "Marc Page"
 __credits__ = ""

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/__init__.py

@@ -1,4 +1,4 @@
-""" initialize azure module """
+"""initialize azure module"""
 
 # re export symbols for easier use
 from .azureobject import AzureObject

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/azureobject.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" An Azure Devops WorkItem """
+"""An Azure Devops WorkItem"""
 
 
 from msrest.serialization import Model

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/builds/build.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-""" Azure Build """
+"""Azure Build"""
 
 from azure.devops.v7_1.build.models import Build as AzureBuild
 from azure.devops.v7_1.build import BuildClient

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/builds/client.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Azure Build Client """
+"""Azure Build Client"""
 
 
 from datetime import datetime
@@ -16,7 +16,7 @@ class Client:  # pylint: disable=too-few-public-methods
     def __init__(self, client: BuildClient):
         self.client = client
 
-    def list(  # pylint: disable=too-many-arguments
+    def list(  # pylint: disable=too-many-positional-arguments,too-many-arguments
         self,
         project: str,
         pipelines: list[int] = None,

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/clients.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Establish a connection to Azure Devops 
+"""Establish a connection to Azure Devops
 
 API Documented here:
 https://github.com/microsoft/azure-devops-python-api

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/pipeline/client.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Pipeline client """
+"""Pipeline client"""
 
 
 from azure.devops.v7_1.pipelines import PipelinesClient

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/pipeline/log.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Azure Pipeline Run Log """
+"""Azure Pipeline Run Log"""
 
 
 from azure.devops.v7_1.pipelines.models import Log as AzureLog

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/pipeline/pipeline.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Azure Pipeline """
+"""Azure Pipeline"""
 
 
 from azure.devops.v7_1.pipelines.models import Pipeline as AzurePipeline

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/pipeline/run.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Pipeline Run """
+"""Pipeline Run"""
 
 
 from azure.devops.v7_1.pipelines.models import Pipeline

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/timestamp.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Tools that help when working with Azure """
+"""Tools that help when working with Azure"""
 
 
 from datetime import datetime, timezone, timedelta

devopsdriver-0.1.49/devopsdriver/azdo/workitem/__init__.py

@@ -0,0 +1 @@
+"""init workitem module"""

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/workitem/client.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Azure WorkItem Client """
+"""Azure WorkItem Client"""
 
 
 from azure.devops.v7_1.work_item_tracking.models import Wiql as AzureWiql
@@ -43,7 +43,7 @@ class Client:
             top=top,
         )
 
-    def get_history(  # pylint: disable=too-many-arguments
+    def get_history(  # pylint: disable=too-many-positional-arguments,too-many-arguments
         self,
         wi_id: int,
         project: str = None,

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/azdo/workitem/wiql.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Builds a WIQL query
+"""Builds a WIQL query
 https://learn.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax?view=azure-devops
 
 SELECT

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/dataobject.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 
-""" Data Objects """
+"""Data Objects"""
 
 
 from json import dumps

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/manage_settings.py

@@ -1,10 +1,10 @@
 #!/usr/bin/env python3
 
 
-""" Module Doc """
+"""Module Doc"""
 
 
-from os.path import dirname, join
+from os.path import dirname, join, abspath
 from sys import argv as sys_argv
 from getpass import getpass as os_getpass
 
@@ -31,7 +31,14 @@ def main() -> None:
         )
         return
 
-    settings = Settings(__file__, dirname(dirname(__file__))).key("secrets")
+    position = args.index("--script") if "--script" in args else len(args)
+    script = __file__
+
+    if position + 1 < len(args):
+        args.pop(position)
+        script = abspath(args.pop(position))
+
+    settings = Settings(script, dirname(dirname(__file__))).key("secrets")
 
     if "--secrets" in args:
         args.remove("--secrets")

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/sendmail.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Ability to send emails with embedded images """
+"""Ability to send emails with embedded images"""
 
 
 from smtplib import SMTP as OS_SMTP, SMTP_SSL as OS_SMTP_SSL

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/settings.py

@@ -1,78 +1,78 @@
 #!/usr/bin/env python3
 
 
-""" Settings that can be in files, environment, or on the command line 
-
-    Settings can be set on the command line, environment, in the code, or in files.
-    
-    Priority order:
-    - in code
-    - command line
-    - environment
-    - files
-    
-    Files can be JSON or YAML.
-    They must have .json, .yml, or .yaml extension.
-    Files can be named after the file passed in (__file__) or "devopsdriver".
-    All files named after the file passed in have priority over "devopsdriver".
-    This allows for shared settings for multiple scripts as well as specific settings.
-    Files can be in an OS-specific preferences location, a series of specified directories, 
-        or next to the file passed in (__file__).
-    This allows for secrets, keys, and tokens to be stored on the machine and not in the repo.
-    
-    The OS specific directories are:
-    - macOS: ~/Library/Preferences/
-    - Windows: %APPDATA%/
-    - Linux: ~/.devopsdriver/
-    
-    You can have environment variable substitutions in the values in the files.
-    For instance, you can specify:
-    
-    output: ${home}/reports
-    
-    The `${home}` will be replaced with the value of the HOME environment variable, if it exists.
-    If the environment variable does not exist, no change is made.
-    
-    Use case 1: Secrets not in repo
-        tokens, passwords, etc can be stored in <pref>/devopsdriver.yml
-        This will allow for all scripts to access those secrets
-            but they are not in the repo.
-        For pipeline runs these secrets can be passed on the command line or in the environment.
-    
-    Use case 2: common settings among scripts
-        Store your common settings in devopsdriver.yml next to your script.
-        All scripts in this directory will have access to these settings.
-        For instance, say you want all emails sent from the same person.
-        You could set 'email: me@domain.com' in devopsdriver.html.
-        You could also, store report paths, emails, groups, holidays, etc.
-        Any data all scripts may want to have access to.
-        
-    Use case 3: configurable settings
-        Any settings in your script that you may want to configure.
-        If your script is `cool_script.py` then put the settings in `cool_script.yml` next to it.
-        This could be colors, emails, repos, queries, whatever.
-    
-    Use case 4: override secrets for specific script
-        Overriding secrets stored in <pref>/devopsdrive.yml for specific scripts.
-        If your script is `cool_script.py` save them to <pref>cool_script.yml.
-    
-    *Note*: You can override a specific setting in a sub-dictionary.
-    For instance, say <pref>/devopsdrive.yml:
-    
-    ```yaml
-    api:
-        user: johndoe
-        password: Setec Astronomy
-    ```
-    
-    You could override this for `cool_script.py` be adding <pref>cool_script.yml:
-    
-    ```yaml
-    api:
-        user: janedoe
-    ```
-    
-    johndoe and janedoe share the same password, so you just need to update the `user`
+"""Settings that can be in files, environment, or on the command line
+
+Settings can be set on the command line, environment, in the code, or in files.
+
+Priority order:
+- in code
+- command line
+- environment
+- files
+
+Files can be JSON or YAML.
+They must have .json, .yml, or .yaml extension.
+Files can be named after the file passed in (__file__) or "devopsdriver".
+All files named after the file passed in have priority over "devopsdriver".
+This allows for shared settings for multiple scripts as well as specific settings.
+Files can be in an OS-specific preferences location, a series of specified directories,
+    or next to the file passed in (__file__).
+This allows for secrets, keys, and tokens to be stored on the machine and not in the repo.
+
+Files in the OS specific directories have priority over other files and are stored in:
+- macOS: ~/Library/Preferences/
+- Windows: %APPDATA%/
+- Linux: ~/.devopsdriver/
+
+You can have environment variable substitutions in the values in the files.
+For instance, you can specify:
+
+output: ${home}/reports
+
+The `${home}` will be replaced with the value of the HOME environment variable, if it exists.
+If the environment variable does not exist, no change is made.
+
+Use case 1: Secrets not in repo
+    tokens, passwords, etc can be stored in <pref>/devopsdriver.yml
+    This will allow for all scripts to access those secrets
+        but they are not in the repo.
+    For pipeline runs these secrets can be passed on the command line or in the environment.
+
+Use case 2: common settings among scripts
+    Store your common settings in devopsdriver.yml next to your script.
+    All scripts in this directory will have access to these settings.
+    For instance, say you want all emails sent from the same person.
+    You could set 'email: me@domain.com' in devopsdriver.html.
+    You could also, store report paths, emails, groups, holidays, etc.
+    Any data all scripts may want to have access to.
+
+Use case 3: configurable settings
+    Any settings in your script that you may want to configure.
+    If your script is `cool_script.py` then put the settings in `cool_script.yml` next to it.
+    This could be colors, emails, repos, queries, whatever.
+
+Use case 4: override secrets for specific script
+    Overriding secrets stored in `<pref>/devopsdriver.yml` for specific scripts.
+    If your script is `cool_script.py` save them to `<pref>/cool_script.yml`.
+
+*Note*: You can override a specific setting in a sub-dictionary.
+For instance, say `<pref>/devopsdriver.yml`:
+
+```yaml
+api:
+    user: johndoe
+    password: Setec Astronomy
+```
+
+You could override this for `cool_script.py` be adding `<pref>/cool_script.yml`:
+
+```yaml
+api:
+    user: janedoe
+```
+
+johndoe and janedoe share the same password, so you just need to update the `user`
 """
 
 
@@ -143,19 +143,29 @@ class Settings:
     PREF_DIR = {
         "Darwin": join(ENVIRON.get("HOME", ""), "Library", "Preferences"),
         "Windows": join(ENVIRON.get("APPDATA", "")),
-        "Linux": join(ENVIRON.get("HOME", ""), ".devopsdriver"),
+        "Linux": join(ENVIRON.get("HOME", ""), ".%shared_name%"),
     }
     ENV_VAR_PATTERN = regex(r"\${(\S+)}")
 
-    def __init__(self, file: str, *directories, **settings):
+    def __init__(self, file: str, *directories, shared_name: str = None, **settings):
         """Create a settings object using a file, directories to search, and settings overrides
 
         Args:
             file (str): The basename to use and a directory to search. pass __file__
+            *directories (list[str]): You can pass other directories to search for files
+            shared_name (str, optional): The name of the common settings file.
+                                        Defaults to "devopsdriver".
+            **settings (dict[str,str]): Keys you want to directly override in the code
         """
         self.overrides = settings
-        directories = [dirname(file), *directories, Settings.__preferences_dir()]
-        search_info = Settings.__all_paths(file, directories)
+        directories = [
+            Settings.__preferences_dir(SHARED if shared_name is None else shared_name),
+            dirname(file),
+            *directories,
+        ]
+        search_info = Settings.__all_paths(
+            file, directories, SHARED if shared_name is None else shared_name
+        )
         self.search_files = [join(d, n + e) for e, n, d, _ in search_info]
         self.settings = Settings.__find_all_settings(search_info)
         self.opts = {}
@@ -316,9 +326,14 @@ class Settings:
         return self.get(key)
 
     @staticmethod
-    def __preferences_dir() -> str:
-        default_dir = Settings.PREF_DIR[Settings.DEFAULT_PREF_DIR]
-        directory = Settings.PREF_DIR.get(SYSTEM(), default_dir)
+    def __preferences_dir(shared_name: str) -> str:
+
+        default_dir = Settings.PREF_DIR[Settings.DEFAULT_PREF_DIR].replace(
+            "%shared_name%", shared_name
+        )
+        directory = Settings.PREF_DIR.get(SYSTEM(), default_dir).replace(
+            "%shared_name%", shared_name
+        )
         MAKEDIRS(directory, exist_ok=True)
         return directory
 
@@ -341,8 +356,8 @@ class Settings:
                 Settings.__merge(base[key], new[key])
 
     @staticmethod
-    def __all_paths(file: str, directories: list[str]) -> list[tuple]:
-        names = [splitext(basename(file))[0], SHARED]
+    def __all_paths(file: str, directories: list[str], shared: str) -> list[tuple]:
+        names = [splitext(basename(file))[0], shared]
         return [
             (e, n, d, f)
             for n in names

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver/template.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-""" Module Doc """
+"""Module Doc"""
 
 
 from os.path import dirname, basename, splitext

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: devopsdriver
-Version: 0.1.46
+Version: 0.1.49
 Summary: DevOps tools
 Author-email: Marc Page <marcallenpage@gmail.com>
 License: This is free and unencumbered software released into the public domain.
@@ -47,10 +47,10 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML==6.0.2
-Requires-Dist: keyring==25.3.0
-Requires-Dist: setuptools==72.1.0
+Requires-Dist: keyring==25.6.0
+Requires-Dist: setuptools==75.8.0
 Requires-Dist: azure-devops==7.1.0b4
-Requires-Dist: Mako==1.3.5
+Requires-Dist: Mako==1.3.10
 Provides-Extra: dev
 Requires-Dist: black>=24.3.0; extra == "dev"
 Requires-Dist: pylint>=3.1.0; extra == "dev"
@@ -58,9 +58,12 @@ Provides-Extra: test
 Requires-Dist: pytest>=8.1.1; extra == "test"
 Requires-Dist: coverage>=7.4.4; extra == "test"
 Provides-Extra: doc
+Dynamic: license-file
+
+# devops-driver
 
 ![status sheild](https://img.shields.io/static/v1?label=status&message=beta&color=blue&style=plastic)
-[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.46&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.46/)
+[![status sheild](https://img.shields.io/static/v1?label=released&message=v0.1.49&color=active&style=plastic)](https://pypi.org/project/devopsdriver/0.1.49/)
 [![GitHub](https://img.shields.io/github/license/marcpage/devops-driver?style=plastic)](https://github.com/marcpage/devops-driver?tab=Unlicense-1-ov-file#readme)
 [![GitHub contributors](https://img.shields.io/github/contributors/marcpage/devops-driver?style=flat)](https://github.com/marcpage/devops-driver/graphs/contributors)
 [![PR's Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
@@ -82,13 +85,11 @@ Provides-Extra: doc
 [![Azure](https://img.shields.io/static/v1?label=&message=Supports%20Microsoft%20Azure&color=blue&style=plastic&logo=microsoftazure)](https://azure.microsoft.com/)
 [![Gmail](https://img.shields.io/static/v1?label=&message=Supports%20Google%20Gmail&color=white&style=plastic&logo=gmail)](https://gmail.com/)
 
-OS: 
+OS:
 [![Windows](https://img.shields.io/static/v1?label=&message=Windows&color=blue&style=plastic&logo=windows)](https://microsoft.com/)
 [![macOS](https://img.shields.io/static/v1?label=&message=macOS&color=white&logoColor=black&style=plastic&logo=apple)](https://apple.com/)
 [![Linux](https://img.shields.io/static/v1?label=&message=Linux&color=seashell&logoColor=black&style=plastic&logo=linux)](https://linux.org/)
 
-# devops-driver
-
 Devops-driver is a collection of tools to help streamline developer's experience and gain insights into various processes.
 
 ## Tools
@@ -107,6 +108,7 @@ To allow seamless work in both pipelines as well as in the development environme
 Say you want a pipeline that looks for User Stories that are newer than 3 days and send out an email.
 
 ### \<platform dependent path\>/devopsdriver.yml
+
 ```yaml
 smtp:
     sender: JohnDoe@company.com
@@ -116,7 +118,7 @@ secrets:
     smtp.password: smtp/password
 ```
 
-This file is in a global place (location varies by OS) and stores information that you may not want in your repository or is specific to development. 
+This file is in a global place (location varies by OS) and stores information that you may not want in your repository or is specific to development.
 
 | Platform | Global Directory       |
 |----------|------------------------|
@@ -127,6 +129,7 @@ This file is in a global place (location varies by OS) and stores information th
 The `secrets` are extra sensative and are stored in the OS keychain.
 
 ### Set secrets in the keychain
+
 ```bash
 $ python3 -m venv .venv
 $ source .venv/bin/activate
@@ -138,16 +141,21 @@ secret: azure.token  key: azure/token
 smtp.password (azure/token): ****
 $ settings --secrets
 secret: azure.token  key: azure/token
-	Value set
+    Value set
 secret: smtp.password  key: smtp/password
-	Value set
+    Value set
 $
 ```
+
 The first call to `settings` will look for every secret and check if they are already set in the keychain.
 For any secret that has not been set in the keychain, you will be prompted to enter the password to store.
 The second call to `settings` will verify that all the values have been set in the keychain.
 
+**Note**: If your `secrets`, `cli`, or `env` are in a yaml file named after your script,
+you can call `settings --secrets --script my_script.py`.
+
 ### devopsdriver.yml
+
 ```yaml
 azure:
     url: https://dev.azure.com/MyCompany
@@ -173,15 +181,18 @@ The `cli` and `env` map command line switches and environment variables to those
 This allows for many options for setting values depending on your needs.
 
 ### new_stories.yml
+
 ```yaml
 scrum masters:
     - JohnDoe@company.com
     - JaneDoe@company.com
 ```
+
 This file is specific to your script and not shared.
 These are values that you want to use in your script but have them here for easy adjustment.
 
 ### new_stories.html.mako
+
 ```html
 <h1>Stories created in the last ${days} days</h1>
 <ul>
@@ -194,6 +205,7 @@ These are values that you want to use in your script but have them here for easy
 This file is the template for the email body.
 
 ### new_stories.py
+
 ```python
 from datetime import date, timedelta
 
@@ -229,9 +241,9 @@ send_email(
 
 ### The email sent
 
-**From**: JohnDoe@company.com
+**From**: `JohnDoe@company.com`
 
-**To**: JohnDoe@company.com, JaneDoe@company.com
+**To**: `JohnDoe@company.com`, `JaneDoe@company.com`
 
 **Subject**: Stories created in the last 3 days
 
@@ -246,4 +258,3 @@ send_email(
 - 754 frontend - store to schema
 - 755 Transfer job to production. Setup migrations to move to production
 - 756 Query subscription status from App
-

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/devopsdriver.egg-info/requires.txt

@@ -1,8 +1,8 @@
 PyYAML==6.0.2
-keyring==25.3.0
-setuptools==72.1.0
+keyring==25.6.0
+setuptools==75.8.0
 azure-devops==7.1.0b4
-Mako==1.3.5
+Mako==1.3.10
 
 [dev]
 black>=24.3.0

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/pyproject.toml

@@ -2,31 +2,37 @@
 name = "devopsdriver"
 description = "DevOps tools"
 readme = "README.md"
-license = {file = "LICENSE"}
+license = { file = "LICENSE" }
 dynamic = ["version"]
 requires-python = ">= 3.10"
 dependencies = [
   "PyYAML==6.0.2",
-  "keyring==25.3.0",
-  "setuptools==72.1.0",  # neded for azure-devops to use 7.1 API
+  "keyring==25.6.0",
+  "setuptools==75.8.0",    # neded for azure-devops to use 7.1 API
   "azure-devops==7.1.0b4",
-  "Mako==1.3.5",
+  "Mako==1.3.10",
 ]
-keywords = ["azure", "devops", "jira", "confluence", "email", "pipelines", "tools"]
-classifiers=[
-    "Development Status :: 1 - Planning",
-    "Environment :: Console",
-    "Intended Audience :: Developers",
-    "Programming Language :: Python",
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: The Unlicense (Unlicense)",
-    "Programming Language :: Python :: 3.10",
-    "Topic :: Utilities",
-    "Topic :: Software Development",
+keywords = [
+  "azure",
+  "devops",
+  "jira",
+  "confluence",
+  "email",
+  "pipelines",
+  "tools",
 ]
-authors = [
-  {name = "Marc Page", email = "marcallenpage@gmail.com"},
+classifiers = [
+  "Development Status :: 1 - Planning",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: The Unlicense (Unlicense)",
+  "Programming Language :: Python :: 3.10",
+  "Topic :: Utilities",
+  "Topic :: Software Development",
 ]
+authors = [{ name = "Marc Page", email = "marcallenpage@gmail.com" }]
 
 [project.scripts]
 settings = "devopsdriver.manage_settings:main"
@@ -38,14 +44,8 @@ settings = "devopsdriver.manage_settings:main"
 include = ["devopsdriver*"]
 
 [project.optional-dependencies]
-dev = [
-    "black>=24.3.0",
-    "pylint>=3.1.0",
-]
-test = [
-    "pytest>=8.1.1",
-    "coverage>=7.4.4",
-]
+dev = ["black>=24.3.0", "pylint>=3.1.0"]
+test = ["pytest>=8.1.1", "coverage>=7.4.4"]
 doc = []
 
 [project.urls]
@@ -56,9 +56,8 @@ Issues = "https://github.com/marcpage/devops-driver/issues"
 Changelog = "https://github.com/marcpage/devops-driver/releases"
 
 [tool.setuptools.dynamic]
-version = {attr = "devopsdriver.__version__"}
+version = { attr = "devopsdriver.__version__" }
 
 [build-system]
 requires = ["setuptools >= 69.2"]
 build-backend = "setuptools.build_meta"
-

{devopsdriver-0.1.46 → devopsdriver-0.1.49}/tests/test_settings.py

@@ -98,6 +98,40 @@ def test_basic():
                 .env("yy", "yota")
             )
             ltr = {"Linux": "l", "Darwin": "m", "Windows": "w", "Unknown": "l"}
+            local_overrides = {
+                "Darwin": {
+                    "v": "mmv",
+                    "dp.v": "mmv",
+                    "w": "mmw",
+                    "dp.w": "mmw",
+                    "x": "mmx",
+                    "dp.x": "mmx",
+                },
+                "Linux": {
+                    "v": "mlv",
+                    "dp.v": "mlv",
+                    "w": "mlw",
+                    "dp.w": "mlw",
+                    "x": "mlx",
+                    "dp.x": "mlx",
+                },
+                "Windows": {
+                    "v": "mwv",
+                    "dp.v": "mwv",
+                    "w": "mww",
+                    "dp.w": "mww",
+                    "x": "mwx",
+                    "dp.x": "mwx",
+                },
+                "Unknown": {
+                    "v": "mlv",
+                    "dp.v": "mlv",
+                    "w": "mlw",
+                    "dp.w": "mlw",
+                    "x": "mlx",
+                    "dp.x": "mlx",
+                },
+            }
             assert opts["yy"] == "yyenviron", opts["yy"]
             assert opts["aa"] == 1, f"{opts['aa']} {os}"
             assert opts["bb"] == 2, f"{opts['bb']} {os}"
@@ -145,12 +179,12 @@ def test_basic():
             assert opts["dp.t"] == "2ammt", f"{opts['dp.t']} {os}"
             assert opts["u"] == "2smmu", f"{opts['u']} {os}"
             assert opts["dp.u"] == "2smmu", f"{opts['dp.u']} {os}"
-            assert opts["v"] == "2mtmv", f"{opts['v']} {os}"
-            assert opts["dp.v"] == "2mtmv", f"{opts['dp.v']} {os}"
-            assert opts["w"] == "2atmw", f"{opts['w']} {os}"
-            assert opts["dp.w"] == "2atmw", f"{opts['dp.w']} {os}"
-            assert opts["x"] == "2stmx", f"{opts['x']} {os}"
-            assert opts["dp.x"] == "2stmx", f"{opts['dp.x']} {os}"
+            assert opts["v"] == local_overrides[os]["v"], f"{opts['v']} {os}"
+            assert opts["dp.v"] == local_overrides[os]["dp.v"], f"{opts['dp.v']} {os}"
+            assert opts["w"] == local_overrides[os]["w"], f"{opts['w']} {os}"
+            assert opts["dp.w"] == local_overrides[os]["dp.w"], f"{opts['dp.w']} {os}"
+            assert opts["x"] == local_overrides[os]["x"], f"{opts['x']} {os}"
+            assert opts["dp.x"] == local_overrides[os]["dp.x"], f"{opts['dp.x']} {os}"
             assert opts["y"] == f"m{ltr[os]}y", f"{opts['y']} m{ltr[os]}y {os}"
             assert opts["dp.y"] == f"m{ltr[os]}y", f"{opts['dp.y']} m{ltr[os]}y {os}"
 

devopsdriver-0.1.46/devopsdriver/azdo/workitem/__init__.py

@@ -1 +0,0 @@
-""" init workitem module """