runbooks 1.1.4__py3-none-any.whl → 1.1.6__py3-none-any.whl

runbooks/inventory/list_route53_hosted_zones.py

@@ -57,12 +57,10 @@ from time import time
 
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError
-from colorama import Fore, init
+from runbooks.common.rich_utils import console
 from Inventory_Modules import display_results, find_private_hosted_zones2, get_all_credentials
 
-init()
 __version__ = "2023.11.08"
-ERASE_LINE = "\x1b[2K"
 
 ########################
 
@@ -307,12 +305,12 @@ if __name__ == "__main__":
     display_results(sorted_results, display_dict, None, pFilename)
 
     print(
-        f"{Fore.RED}Found {len(AllHostedZones)} Hosted Zones across {len(AllAccountList)} accounts across {len(AllRegionList)} regions{Fore.RESET}"
+        f"[red]Found {len(AllHostedZones)} Hosted Zones across {len(AllAccountList)} accounts across {len(AllRegionList)} regions"
     )
     print()
     if pTiming:
         print(ERASE_LINE)
-        print(f"{Fore.GREEN}This script took {time() - begin_time:.2f} seconds{Fore.RESET}")
+        print(f"[green]This script took {time() - begin_time:.2f} seconds")
         print(ERASE_LINE)
     print("Thanks for using this script...")
     print()

runbooks/inventory/list_servicecatalog_provisioned_products.py

@@ -97,11 +97,10 @@ import Inventory_Modules
 from account_class import aws_acct_access
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError, ProfileNotFound, UnknownCredentialError, UnknownRegionError
-from colorama import Fore, init
+from runbooks.common.rich_utils import console
 from Inventory_Modules import display_results
-from tqdm.auto import tqdm
+from runbooks.common.rich_utils import create_progress_bar
 
-init()
 __version__ = "2023.08.09"
 
 parser = CommonArguments()
@@ -175,7 +174,7 @@ def find_account_stacksets(faws_acct, f_SCProducts, fRegion=None, fstacksetname=
                 # Get the work from the queue and expand the tuple
                 c_sc_product, c_region, c_fstacksetname, c_PlacesToLook, c_PlaceCount = self.queue.get()
                 logging.info(f"De-queued info for SC Product: {c_sc_product['SCPName']}")
-                logging.info(f"{Fore.RED}Checking {PlaceCount} of {len(f_SCProducts)} products{Fore.RESET}")
+                logging.info(f"[red]Checking {PlaceCount} of {len(f_SCProducts)} products")
                 CFNresponse = Inventory_Modules.find_stacks3(faws_acct, pRegion, c_sc_product["SCPId"])
                 logging.info(
                     f"There are {len(CFNresponse)} matches for SC Provisioned Product Name {c_sc_product['SCPName']}"
@@ -206,10 +205,10 @@ def find_account_stacksets(faws_acct, f_SCProducts, fRegion=None, fstacksetname=
                                         AccountStatus = AccountHistogram[AccountID]
                                     else:
                                         AccountStatus = "Closed"
-                                    logging.info(f"{Fore.RED}Found the Account ID: {AccountID}{Fore.RESET}")
+                                    logging.info(f"[red]Found the Account ID: {AccountID}")
                                     if AccountID in SuspendedAccounts:
                                         logging.error(
-                                            f"{Fore.RED}Account ID {AccountID} has been suspended{Fore.RESET}"
+                                            f"[red]Account ID {AccountID} has been suspended"
                                         )
                                     break
                                 else:
@@ -258,7 +257,7 @@ def find_account_stacksets(faws_acct, f_SCProducts, fRegion=None, fstacksetname=
                     logging.info(
                         f"Finished finding product {c_sc_product['SCPName']} - {c_PlaceCount} / {c_PlacesToLook}"
                     )
-                    pbar.update()
+                    progress.update(task, advance=1)
                     self.queue.task_done()
 
     if fRegion is None:
@@ -269,33 +268,31 @@ def find_account_stacksets(faws_acct, f_SCProducts, fRegion=None, fstacksetname=
     PlaceCount = 0
     PlacesToLook = WorkerThreads = min(len(f_SCProducts), 10)
 
-    pbar = tqdm(
-        desc=f"Reconciling SC Products with CloudFormation Stacks in accounts",
-        leave=True,
-        total=len(f_SCProducts),
-        unit=" products",
-    )
+    with create_progress_bar() as progress:
+        task = progress.add_task(
+            f"Reconciling SC Products with CloudFormation Stacks in accounts",
+            total=len(f_SCProducts)
+        )
 
-    # Create and start the worker threads
-    for x in range(WorkerThreads):
-        worker = CheckProducts(checkqueue)
-        # Setting daemon to True will let the main thread exit even though the workers are blocking
-        worker.daemon = True
-        worker.start()
-
-    for SCProduct in SCProducts:
-        logging.info(f"Checking service catalog product: {SCProduct['SCPName']}")
-        try:
-            # print(f"{ERASE_LINE}Queuing account {credential['AccountId']} in region {region}", end='\r')
-            checkqueue.put((SCProduct, fRegion, fstacksetname, PlacesToLook, PlaceCount))
-            PlaceCount += 1
-        except ClientError as my_Error:
-            if "AuthFailure" in str(my_Error):
-                logging.error(f"Authorization Failure accessing account {faws_acct.acct_number} in {fRegion} region")
-                logging.warning(f"It's possible that the region {fRegion} hasn't been opted-into")
-                pass
-    checkqueue.join()
-    pbar.close()
+        # Create and start the worker threads
+        for x in range(WorkerThreads):
+            worker = CheckProducts(checkqueue)
+            # Setting daemon to True will let the main thread exit even though the workers are blocking
+            worker.daemon = True
+            worker.start()
+
+        for SCProduct in SCProducts:
+            logging.info(f"Checking service catalog product: {SCProduct['SCPName']}")
+            try:
+                # print(f"{ERASE_LINE}Queuing account {credential['AccountId']} in region {region}", end='\r')
+                checkqueue.put((SCProduct, fRegion, fstacksetname, PlacesToLook, PlaceCount))
+                PlaceCount += 1
+            except ClientError as my_Error:
+                if "AuthFailure" in str(my_Error):
+                    logging.error(f"Authorization Failure accessing account {faws_acct.acct_number} in {fRegion} region")
+                    logging.warning(f"It's possible that the region {fRegion} hasn't been opted-into")
+                    pass
+        checkqueue.join()
     return SCP2Stacks
 
 
@@ -320,7 +317,6 @@ Significant Variable Explanation:
 """
 begin_time = time()
 
-ERASE_LINE = "\x1b[2K"
 
 print()
 
@@ -437,7 +433,7 @@ def main():
 
         if pTiming:
             print(
-                f"{Fore.GREEN}Finding stacks in your account has taken {time() - begin_time:.2f} seconds now...{Fore.RESET}"
+                f"[green]Finding stacks in your account has taken {time() - begin_time:.2f} seconds now..."
             )
             milestone1 = time()
 
@@ -454,7 +450,7 @@ def main():
 
         if pTiming:
             print(
-                f"{Fore.GREEN}Reconciling products to the CloudFormation stacks took {time() - milestone1:.2f} seconds{Fore.RESET}"
+                f"[green]Reconciling products to the CloudFormation stacks took {time() - milestone1:.2f} seconds"
             )
 
         # TODO: This might not be a good idea, if it misses the stacks which are associated with accounts no longer within the Org.
@@ -501,21 +497,21 @@ def main():
             pass  # This is the desired state, so no user output is needed.
         elif AccountHistogram[acctnum] == "SUSPENDED":
             print(
-                f"{Fore.RED}While there is no SC Product associated, account number {acctnum} appears to be a suspended account.{Fore.RESET}"
+                f"[red]While there is no SC Product associated, account number {acctnum} appears to be a suspended account."
             )
         elif (
             AccountHistogram[acctnum] == "ACTIVE"
         ):  # This compare needs to be separate from below, since we can't compare a string with a "<" operator
             print(
-                f"Account Number {Fore.RED}{acctnum}{Fore.RESET} appears to have no SC Product associated with it. This can be a problem"
+                f"Account Number [red]{acctnum} appears to have no SC Product associated with it. This can be a problem"
             )
         elif AccountHistogram[acctnum] < 1:
             print(
-                f"Account Number {Fore.RED}{acctnum}{Fore.RESET} appears to have no SC Product associated with it. This can be a problem"
+                f"Account Number [red]{acctnum} appears to have no SC Product associated with it. This can be a problem"
             )
         elif AccountHistogram[acctnum] > 1:
             print(
-                f"Account Number {Fore.RED}{acctnum}{Fore.RESET} appears to have multiple SC Products associated with it. This can be a problem"
+                f"Account Number [red]{acctnum} appears to have multiple SC Products associated with it. This can be a problem"
             )
 
     if ErroredSCProductExists:
@@ -561,7 +557,7 @@ def main():
     end_time = time()
     duration = end_time - begin_time
     if pTiming:
-        print(f"{Fore.GREEN}This script took {duration:.2f} seconds{Fore.RESET}")
+        print(f"[green]This script took {duration:.2f} seconds")
     print(f"We found {len(aws_acct.ChildAccounts)} accounts within the Org")
     print(f"We found {len(SCProducts)} Service Catalog Products")
     print(f"We found {len(SuspendedAccounts)} Suspended accounts")

runbooks/inventory/list_sns_topics.py

@@ -69,10 +69,9 @@ from time import time
 import Inventory_Modules
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError
-from colorama import Fore, init
+from runbooks.common.rich_utils import console
 from Inventory_Modules import display_results, get_all_credentials
 
-init()
 __version__ = "2023.11.08"
 begin_time = time()
 
@@ -317,7 +316,6 @@ def present_results(f_data_found: list):
 
 
 ##########################
-ERASE_LINE = "\x1b[2K"
 
 if __name__ == "__main__":
     args = parse_args(sys.argv[1:])
@@ -355,6 +353,6 @@ if __name__ == "__main__":
 
     print()
     if pTiming:
-        print(f"{Fore.GREEN}This script completed in {time() - begin_time:.2f} seconds{Fore.RESET}")
+        print(f"[green]This script completed in {time() - begin_time:.2f} seconds")
         print()
 print("Thank you for using this script.")

runbooks/inventory/list_ssm_parameters.py

@@ -64,14 +64,11 @@ from time import time
 
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError
-from colorama import Fore, init
+from runbooks.common.rich_utils import console
 from Inventory_Modules import display_results, find_ssm_parameters2, get_all_credentials
-from tqdm.auto import tqdm
 
-init()
 __version__ = "2024.05.07"
 begin_time = time()
-ERASE_LINE = "\x1b[2K"
 
 
 ##################
@@ -236,7 +233,7 @@ def find_ssm_parameters(f_credentialList):
             parameter_list.extend(find_ssm_parameters2(credential))
         # Optional verbose logging for parameter discovery progress (currently commented)
         # if verbose < 50 or len(parameter_list) == 0:
-        # 	print(f"Found a running total of {len(parameter_list)} parameters in account {Fore.RED}{credential['AccountNumber']}{Fore.RESET} in region {Fore.RED}{credential['Region']}{Fore.RESET}")
+        # 	print(f"Found a running total of {len(parameter_list)} parameters in account [red]{credential['AccountNumber']} in region [red]{credential['Region']}")
         except ClientError as my_Error:
             # Handle AWS API authorization failures gracefully
             if "AuthFailure" in str(my_Error):
@@ -404,7 +401,7 @@ if __name__ == "__main__":
     # Display performance timing metrics for operational optimization
     if pTiming:
         print(ERASE_LINE)
-        print(f"{Fore.GREEN}This script took {time() - begin_time:.2f} seconds{Fore.RESET}")
+        print(f"[green]This script took {time() - begin_time:.2f} seconds")
 
     print()
 
@@ -424,7 +421,7 @@ if __name__ == "__main__":
     # Display completion message and output file information
     print("Thank you for using this script")
     print(
-        f"Your output was saved to {Fore.GREEN}'{pFilename}-{datetime.now().strftime('%y-%m-%d--%H:%M:%S')}'{Fore.RESET}"
+        f"Your output was saved to [green]'{pFilename}-{datetime.now().strftime('%y-%m-%d--%H:%M:%S')}'"
     ) if pFilename is not None else None
 
     print()

runbooks/inventory/list_vpc_subnets.py

@@ -76,10 +76,9 @@ from time import time
 import Inventory_Modules
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError
-from colorama import Fore, init
+from runbooks.common.rich_utils import console
 from Inventory_Modules import display_results, get_all_credentials
 
-init()
 __version__ = "2024.10.24"
 
 # TODO: Add Elastic IPs to this script as well.
@@ -384,7 +383,6 @@ def analyze_results(fSubnetsFound: list):
 ##################
 
 
-ERASE_LINE = "\x1b[2K"
 begin_time = time()
 
 if __name__ == "__main__":
@@ -426,7 +424,7 @@ if __name__ == "__main__":
         analyze_results(SubnetsFound)
     if pTiming:
         print(ERASE_LINE)
-        print(f"{Fore.GREEN}This script completed in {time() - begin_time:.2f} seconds{Fore.RESET}")
+        print(f"[green]This script completed in {time() - begin_time:.2f} seconds")
 
 print()
 print("Thank you for using this script")

runbooks/inventory/list_vpcs.py

@@ -62,10 +62,9 @@ from time import time
 import Inventory_Modules
 from ArgumentsClass import CommonArguments
 from botocore.exceptions import ClientError
-from colorama import Fore, init
 from Inventory_Modules import display_results, get_all_credentials
+from runbooks.common.rich_utils import console
 
-init()
 __version__ = "2024.01.26"
 
 
@@ -324,9 +323,9 @@ def find_all_vpcs(fAllCredentials, fDefaultOnly=False):
 
     for credential in fAllCredentials:
         logging.info(f"Beginning to queue data - starting with {credential['AccountId']}")
-        print(
-            f"{ERASE_LINE}Checking {credential['AccountId']} in region {credential['Region']} - {PlaceCount + 1} / {len(fAllCredentials)}",
-            end="\r",
+        console.print(
+            f"Checking {credential['AccountId']} in region {credential['Region']} - {PlaceCount + 1} / {len(fAllCredentials)}",
+            end="",
         )
         # for region in fRegionList:
         try:
@@ -361,8 +360,6 @@ if __name__ == "__main__":
     verbose = args.loglevel
     logging.basicConfig(level=verbose, format="[%(filename)s:%(lineno)s - %(funcName)30s() ] %(message)s")
 
-    ERASE_LINE = "\x1b[2K"
-
     begin_time = time()
 
     NumVpcsFound = 0
@@ -409,9 +406,9 @@ if __name__ == "__main__":
     logging.info(f"Threads all done - took {time() - begin_time:.2f} seconds")
 
     if pTiming:
-        print(ERASE_LINE)
-        print(f"{Fore.GREEN}This script took {time() - begin_time:.2f} seconds{Fore.RESET}")
-    print(ERASE_LINE)
+        console.print()
+        console.print(f"[green]This script took {time() - begin_time:.2f} seconds[/green]")
+    console.print()
     # Had to do this, because some of the VPCs that show up in the "sorted_AllVPCs" list are actually the same VPC, with a different CIDR range.
     Num_of_unique_VPCs = len(set([x["VpcId"] for x in sorted_AllVPCs]))
     print(