ara-cli 0.1.9.78__py3-none-any.whl → 0.1.9.80__py3-none-any.whl

ara_cli/__main__.py

@@ -20,6 +20,7 @@ from ara_cli.ara_command_action import (
     classifier_directory_action,
     scan_action,
     autofix_action,
+    extract_action
 )
 import argcomplete
 import sys
@@ -45,6 +46,7 @@ def define_action_mapping():
         "classifier-directory": classifier_directory_action,
         "scan": scan_action,
         "autofix": autofix_action,
+        "extract": extract_action
     }
 
 

ara_cli/ara_command_action.py

@@ -609,3 +609,18 @@ def autofix_action(args):
             )
 
     print("\nAutofix process completed. Please review the changes.")
+
+
+def extract_action(args):
+    from ara_cli.commands.extract_command import ExtractCommand
+
+    filename = args.filename
+    skip_queries = args.skip_queries
+    print(file_name)
+    command = ExtractCommand(
+        file_name=filename,
+        skip_queries=skip_queries,
+        output=lambda msg: print(msg, file=sys.stdout),
+        error_output=lambda msg: print(msg, file=sys.stderr)
+    )
+    command.execute()

ara_cli/ara_command_parser.py

@@ -422,6 +422,19 @@ def autofix_parser(subparsers):
     )
 
 
+def extract_parser(subparsers):
+    extract_parser = subparsers.add_parser("extract", help="Extract blocks of marked content from a given file.")
+    extract_parser.add_argument(
+        "filename",
+        help="Input file to extract from."
+    )
+    extract_parser.add_argument(
+        "--skip-queries", "-s",
+        action="store_true",
+        help="Answer queries with yes when extracting."
+    )
+
+
 class CustomHelpFormatter(argparse.HelpFormatter):
     def __init__(self, *args, **kwargs):
         self.add_examples = kwargs.pop("add_examples", False)
@@ -532,5 +545,6 @@ def action_parser():
     classifier_directory_parser(subparsers)
     scan_parser(subparsers)
     autofix_parser(subparsers)
+    extract_parser(subparsers)
 
     return parser

ara_cli/chat.py

@@ -1,8 +1,13 @@
 import os
 import cmd2
+import argparse
 from ara_cli.prompt_handler import send_prompt
 
 
+extract_parser = argparse.ArgumentParser()
+extract_parser.add_argument('-s', '--skip-queries', action='store_true', help='Force extraction')
+
+
 class Chat(cmd2.Cmd):
     CATEGORY_CHAT_CONTROL = "Chat control commands"
     CATEGORY_LLM_CONTROL = "Language model controls"
@@ -741,12 +746,18 @@ Start chatting (type 'HELP'/'h' for available commands, 'QUIT'/'q' to exit chat
         self._load_template_from_global_or_local(template_name=template_name, template_type=template_type)
 
     @cmd2.with_category(CATEGORY_CHAT_CONTROL)
-    def do_EXTRACT(self, _):
-        """Search for markdown code blocks containing \"# [x] extract\" as first line and \"# filename: <path/filename>\" as second line and copy the content of the code block to the specified file. The extracted code block is then marked with \"# [v] extract\""""
-        from ara_cli.prompt_extractor import extract_responses
-
-        extract_responses(self.chat_name, True)
-        print("End of extraction")
+    @cmd2.with_argparser(extract_parser)
+    def do_EXTRACT(self, args):
+        """Search for markdown code blocks containing "# [x] extract" as first line and "# filename: <path/filename>" as second line and copy the content of the code block to the specified file. The extracted code block is then marked with "# [v] extract"."""
+        from ara_cli.commands.extract_command import ExtractCommand
+
+        command = ExtractCommand(
+            file_name=self.chat_name,
+            skip_queries=args.skip_queries,
+            output=self.poutput,
+            error_output=self.perror
+        )
+        command.execute()
 
     @cmd2.with_category(CATEGORY_CHAT_CONTROL)
     def do_LOAD_GIVENS(self, file_name):

ara_cli/commands/command.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class Command(ABC):
+    @abstractmethod
+    def execute(self, *args, **kwargs):     # pragma: no cover
+        pass

ara_cli/commands/extract_command.py

@@ -0,0 +1,21 @@
+from ara_cli.commands.command import Command
+from ara_cli.prompt_extractor import extract_responses
+import os
+
+class ExtractCommand(Command):
+    def __init__(self, file_name, skip_queries=False, output=None, error_output=None):
+        self.file_name = file_name
+        self.skip_queries = skip_queries
+        self.output = output    # Callable for standard output (optional)
+        self.error_output = error_output  # Callable for errors (optional)
+
+    def execute(self, *args, **kwargs):
+        try:
+            extract_responses(self.file_name, True, skip_queries=self.skip_queries)
+            if self.output:
+                self.output("End of extraction")
+        except Exception as e:
+            if self.error_output:
+                self.error_output(f"Extraction failed: {e}")
+            else:
+                raise

ara_cli/prompt_extractor.py

@@ -17,7 +17,7 @@ def extract_code_blocks_md(markdown_text):
     return code_blocks
 
 
-def extract_responses(document_path, relative_to_ara_root=False):
+def extract_responses(document_path, relative_to_ara_root=False, skip_queries=False):
     print(f"Debug: Starting extraction from {document_path}")
     block_extraction_counter = 0
 
@@ -26,7 +26,6 @@ def extract_responses(document_path, relative_to_ara_root=False):
 
     cwd = os.getcwd()
     if relative_to_ara_root:
-        from ara_cli.directory_navigator import DirectoryNavigator
         navigator = DirectoryNavigator()
         navigator.navigate_to_target()
         os.chdir('..')
@@ -52,7 +51,7 @@ def extract_responses(document_path, relative_to_ara_root=False):
             block_lines = block_lines[1:]  # Remove first line again after removing filename line
             block = '\n'.join(block_lines)
 
-            handle_existing_file(file_path, block)
+            handle_existing_file(file_path, block, skip_queries)
             block_extraction_counter += 1
 
             # Update the markdown content
@@ -81,8 +80,7 @@ def extract_responses(document_path, relative_to_ara_root=False):
             artefact_path = artefact.file_path
             directory = os.path.dirname(artefact_path)
             os.makedirs(directory, exist_ok=True)
-            with open(artefact_path, 'w', encoding='utf-8') as file:
-                file.write(serialized_artefact)
+            handle_existing_file(artefact_path, serialized_artefact, skip_queries)
 
             os.chdir(original_directory)
 
@@ -127,12 +125,19 @@ def prompt_user_decision(prompt):
     return input(prompt)
 
 
-def create_file_if_not_exist(filename, content):
+def determine_should_create(skip_query=False):
+    if skip_query:
+        return True
+    user_decision = prompt_user_decision("File does not exist. Create? (y/n): ")
+    if user_decision.lower() in ['y', 'yes']:
+        return True
+    return False
+
+
+def create_file_if_not_exist(filename, content, skip_query=False):
     try:
         if not os.path.exists(filename):
-            user_decision = prompt_user_decision("File does not exist. Create? (y/n): ")
-
-            if user_decision.lower() in ['y', 'yes']:
+            if determine_should_create(skip_query):
                 # Ensure the directory exists
                 os.makedirs(os.path.dirname(filename), exist_ok=True)
 
@@ -170,7 +175,7 @@ def create_prompt_for_file_modification(content_str, filename):
     {{
         "filename": "path/filename.filextension",
         "content":  "full content of the modified file in valid json format"
-    }} 
+    }}
     """
 
     # print(f"Debug: modification prompt created: {prompt_text}")
@@ -178,10 +183,10 @@ def create_prompt_for_file_modification(content_str, filename):
     return prompt_text
 
 
-def handle_existing_file(filename, block_content):
+def handle_existing_file(filename, block_content, skip_query=False):
     if not os.path.isfile(filename):
         print(f"File {filename} does not exist, attempting to create")
-        create_file_if_not_exist(filename, block_content)
+        create_file_if_not_exist(filename, block_content, skip_query)
     else:
         print(f"File {filename} exists, creating modification prompt")
         prompt_text = create_prompt_for_file_modification(block_content, filename)

ara_cli/prompt_handler.py

@@ -25,9 +25,10 @@ class LLMSingleton:
 
         if not selected_config:
             raise ValueError(f"No configuration found for the model: {model_id}")
-
+        if not isinstance(selected_config, LLMConfigItem):
+            selected_config = LLMConfigItem(**selected_config)
         LLMSingleton._model = model_id
-        
+
         # Typesafe for None values inside the config.
         self.config_parameters = selected_config.model_dump(exclude_none=True)
 

ara_cli/version.py

@@ -1,2 +1,2 @@
 # version.py
-__version__ = "0.1.9.78"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers
+__version__ = "0.1.9.80"   # fith parameter like .0 for local install test purposes only. official numbers should be 4 digit numbers

{ara_cli-0.1.9.78.dist-info → ara_cli-0.1.9.80.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.78
+Version: 0.1.9.80
 Summary: Powerful, open source command-line tool for managing, structuring and automating software development artifacts in line with Business-Driven Development (BDD) and AI-assisted processes
 Description-Content-Type: text/markdown
 Requires-Dist: litellm
@@ -24,7 +24,7 @@ Dynamic: summary
 
 # ara-cli
 
-**ara-cli** is a powerful, open source command-line tool for managing, structuring and automating software development artifacts in line with Business-Driven Development (BDD) and AI-assisted processes. With an intuitive interface and platform-independent implementation in Python, ara-cli enables teams to structure business goals, capabilities, features, user stories, and tasks, and to leverage integrated AI/chat capabilities for requirements engineering, documentation, and process automation.
+**ara-cli** is a powerful, open source command-line tool for managing, structuring and automating software development artifacts in line with Behavior-Driven Development (BDD) and AI-assisted processes. With an intuitive interface and platform-independent implementation in Python, ara-cli enables teams to structure business goals, capabilities, features, user stories, and tasks, and to leverage integrated AI/chat capabilities for requirements engineering, documentation, and process automation.
 
 ---
 

{ara_cli-0.1.9.78.dist-info → ara_cli-0.1.9.80.dist-info}/RECORD

@@ -1,7 +1,7 @@
 ara_cli/__init__.py,sha256=0zl7IegxTid26EBGLav_fXZ4CCIV3H5TfAoFQiOHjvg,148
-ara_cli/__main__.py,sha256=ppfq0FIi4x6ONRzP67784A4BPo2labh8Bd_EExuXo4U,2011
-ara_cli/ara_command_action.py,sha256=J613DUTjRxrPG8Jm-fJcIM0QlZTeULmq9Q7DKkDxJHg,22039
-ara_cli/ara_command_parser.py,sha256=vyxLELnyAZFC2C3v0hH4-r9QBmJ8oIs0hCZukkMFXfc,20136
+ara_cli/__main__.py,sha256=J5DCDLRZ6UcpYwM1-NkjaLo4PTetcSj2dB4HrrftkUw,2064
+ara_cli/ara_command_action.py,sha256=a6yqYg40QW8UXSq85J33bZqPNQkjhRkLcS2flt0Zacs,22457
+ara_cli/ara_command_parser.py,sha256=I-e9W-QwTIMKMzlHycSlCWCyBFQfiFYvGre1XsDbrFI,20573
 ara_cli/ara_config.py,sha256=SgZfQVpqj5JJN4SB0n2IvAH0sKIdS3k1K1Zht2wDywA,8814
 ara_cli/artefact_autofix.py,sha256=WVTiIR-jo4YKmmz4eS3qTFvl45W1YKwAk1XSuz9QX10,20015
 ara_cli/artefact_creator.py,sha256=0Ory6cB-Ahkw-BDNb8QHnTbp_OHGABdkb9bhwcEdcIc,6063
@@ -12,7 +12,7 @@ ara_cli/artefact_lister.py,sha256=jhk4n4eqp7hDIq07q43QzS7-36BM3OfZ4EABxCeOGcw,47
 ara_cli/artefact_reader.py,sha256=Pho0_Eqm7kD9CNbVMhKb6mkNM0I3iJiCJXbXmVp1DJU,7827
 ara_cli/artefact_renamer.py,sha256=Hnz_3zD9xxnBa1FHyUE6mIktLk_9ttP2rFRvQIkmz-o,4061
 ara_cli/artefact_scan.py,sha256=msPCm-vPWOAZ_e_z5GylXxq1MtNlmJ4zvKrsdOFCWF4,4813
-ara_cli/chat.py,sha256=Plje33XcOedSx-nmLCkuFIXSqHPIvMcy5I71xYWuYmU,31956
+ara_cli/chat.py,sha256=WguQDTgwJ8F1bnpxM7BtEkGH-jHhAzlC8aFDVig1Kks,32298
 ara_cli/classifier.py,sha256=zWskj7rBYdqYBGjksBm46iTgVU5IIf2PZsJr4qeiwVU,1878
 ara_cli/codefusionretriever.py,sha256=fCHgXdIBRzkVAnapX-KI2NQ44XbrrF4tEQmn5J6clUI,1980
 ara_cli/codehierachieretriever.py,sha256=Xd3EgEWWhkSf1TmTWtf8X5_YvyE_4B66nRrqarwSiTU,1182
@@ -24,14 +24,14 @@ ara_cli/filename_validator.py,sha256=Aw9PL8d5-Ymhp3EY6lDrUBk3cudaNqo1Uw5RzPpI1jA
 ara_cli/list_filter.py,sha256=qKGwwQsrWe7L5FbdxEbBYD1bbbi8c-RMypjXqXvLbgs,5291
 ara_cli/output_suppressor.py,sha256=nwiHaQLwabOjMoJOeUESBnZszGMxrQZfJ3N2OvahX7Y,389
 ara_cli/prompt_chat.py,sha256=kd_OINDQFit6jN04bb7mzgY259JBbRaTaNp9F-webkc,1346
-ara_cli/prompt_extractor.py,sha256=6l1Or7wuFNUDqbMg-NDXpFX-WMi2XV7YGH6hGDvow2o,7557
-ara_cli/prompt_handler.py,sha256=f1J-SAyFQjVgfi0k_Pk4JYotcU_UV4oSrLKoJH-25iM,18576
+ara_cli/prompt_extractor.py,sha256=aY7k9JSfwwbhV3jiNmuijiLss1SlTJ1K_I3Q0sKK85U,7697
+ara_cli/prompt_handler.py,sha256=RN409FCUC1VYvML33mcSIvfofEFrHh9iu3W-RY5ti2k,18689
 ara_cli/prompt_rag.py,sha256=ydlhe4CUqz0jdzlY7jBbpKaf_5fjMrAZKnriKea3ZAg,7485
 ara_cli/run_file_lister.py,sha256=XbrrDTJXp1LFGx9Lv91SNsEHZPP-PyEMBF_P4btjbDA,2360
 ara_cli/tag_extractor.py,sha256=TGdaQOVnjy25R0zDsAifB67C5oom0Fwo24s0_fr5A_I,3151
 ara_cli/template_manager.py,sha256=YwrN6AYPpl6ZrW8BVQpVXx8yTRf-oNpJUIKeg4NAggs,6606
 ara_cli/update_config_prompt.py,sha256=Oy9vNTw6UhDohyTEfSKkqE5ifEMPlmWNYkKHgUrK_pY,4607
-ara_cli/version.py,sha256=8uB-BYYtS-wDJMQLMNnX870pu9lmnUnQMT23kLhsfwE,146
+ara_cli/version.py,sha256=JbVvnt8MB55-_4XtxrGGxjlyQogGwxaaodr4L4TXWmE,146
 ara_cli/artefact_models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ara_cli/artefact_models/artefact_load.py,sha256=IXzWxP-Q_j_oDGMno0m-OuXCQ7Vd5c_NctshGr4ROBw,621
 ara_cli/artefact_models/artefact_mapping.py,sha256=8aD0spBjkJ8toMAmFawc6UTUxB6-tEEViZXv2I-r88Q,1874
@@ -48,6 +48,9 @@ ara_cli/artefact_models/serialize_helper.py,sha256=Wks30wy-UrwJURetydKykLgJkdGRg
 ara_cli/artefact_models/task_artefact_model.py,sha256=1BSMbz9D-RXvdpdd0RlAr9hUx84Rcuysk2YfQC8Qy14,6046
 ara_cli/artefact_models/userstory_artefact_model.py,sha256=2awH31ROtm7j4T44Bv4cylQDYLQtnfgXZMhDu_pgw-k,6435
 ara_cli/artefact_models/vision_artefact_model.py,sha256=frjaUJj-mmIlVHEhzAQztCGs-CtvNu_odSborgztfzo,5251
+ara_cli/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ara_cli/commands/command.py,sha256=Y_2dNeuxRjbyI3ScXNv55lptSe8Hs_ya78L0nPYNZHA,154
+ara_cli/commands/extract_command.py,sha256=TfKuOnKQzJ8JPpJyKDm7qhm5mvbZnHspCem8g6YgACo,835
 ara_cli/templates/agile.artefacts,sha256=nTA8dp98HWKAD-0qhmNpVYIfkVGoJshZqMJGnphiOsE,7932
 ara_cli/templates/template.businessgoal.prompt_log.md,sha256=xF6bkgj_GqAAqHxJWJiQNt11mEuSGemIqoZ2wOo6dI0,214
 ara_cli/templates/template.capability.prompt_log.md,sha256=eO8EzrHgb2vYJ-DP1jGzAfDlMo8nY75hZDfhh0s40uQ,208
@@ -131,7 +134,7 @@ tests/test_artefact_lister.py,sha256=VCEOCgDgnAOeUUgIoGAbWgz60hf9UT-tdHg18LGfB34
 tests/test_artefact_reader.py,sha256=660K-d8ed-j8hulsUB_7baPD2-hhbg9TffUR5yVc4Uo,927
 tests/test_artefact_renamer.py,sha256=lSnKCCfoFGgKhTdDZrEaeBq1xJAak1QoqH5aSeOe9Ro,3494
 tests/test_artefact_scan.py,sha256=uNWgrt7ieZ4ogKACsPqzAsh59JF2BhTKSag31hpVrTQ,16887
-tests/test_chat.py,sha256=fUGqpsyilLjwIFNlCAC69pYGEhwRuU6pplywwGJk-K8,54907
+tests/test_chat.py,sha256=eOj3fQXRUfaRQEjS_tRFuqCgAUYSh0MUkLplYtaM1E8,54927
 tests/test_classifier.py,sha256=grYGPksydNdPsaEBQxYHZTuTdcJWz7VQtikCKA6BNaQ,1920
 tests/test_directory_navigator.py,sha256=7G0MVrBbtBvbrFUpL0zb_9EkEWi1dulWuHsrQxMJxDY,140
 tests/test_file_classifier.py,sha256=kLWPiePu3F5mkVuI_lK_2QlLh2kXD_Mt2K8KZZ1fAnA,10940
@@ -141,8 +144,8 @@ tests/test_list_filter.py,sha256=fJA3d_SdaOAUkE7jn68MOVS0THXGghy1fye_64Zvo1U,796
 tests/test_tag_extractor.py,sha256=nSiAYlTKZ7TLAOtcJpwK5zTWHhFYU0tI5xKnivLc1dU,2712
 tests/test_template_manager.py,sha256=q-LMHRG4rHkD6ON6YW4cpZxUx9hul6Or8wVVRC2kb-8,4099
 tests/test_update_config_prompt.py,sha256=xsqj1WTn4BsG5Q2t-sNPfu7EoMURFcS-hfb5VSXUnJc,6765
-ara_cli-0.1.9.78.dist-info/METADATA,sha256=j8cLr6oh3gVDON2FJE-pds7Psqspoxsgo008NV6btWw,6739
-ara_cli-0.1.9.78.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ara_cli-0.1.9.78.dist-info/entry_points.txt,sha256=v4h7MzysTgSIDYfEo3oj4Kz_8lzsRa3hq-KJHEcLVX8,45
-ara_cli-0.1.9.78.dist-info/top_level.txt,sha256=WM4cLHT5DYUaWzLtRj-gu3yVNFpGQ6lLRI3FMmC-38I,14
-ara_cli-0.1.9.78.dist-info/RECORD,,
+ara_cli-0.1.9.80.dist-info/METADATA,sha256=boiCl52joIvK3TyGQ4Y3-La2zoBqC-YEDs1dPh9l43I,6739
+ara_cli-0.1.9.80.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ara_cli-0.1.9.80.dist-info/entry_points.txt,sha256=v4h7MzysTgSIDYfEo3oj4Kz_8lzsRa3hq-KJHEcLVX8,45
+ara_cli-0.1.9.80.dist-info/top_level.txt,sha256=WM4cLHT5DYUaWzLtRj-gu3yVNFpGQ6lLRI3FMmC-38I,14
+ara_cli-0.1.9.80.dist-info/RECORD,,

tests/test_chat.py

@@ -1173,7 +1173,7 @@ def test_do_EXTRACT(temp_chat_file, capsys):
 
     with patch('ara_cli.prompt_extractor.extract_responses') as mock_extract_responses:
         chat.do_EXTRACT("")
-        mock_extract_responses.assert_called_once_with(temp_chat_file.name, True)
+        mock_extract_responses.assert_called_once_with(temp_chat_file.name, True, skip_queries=False)
 
     captured = capsys.readouterr()
     assert "End of extraction" in captured.out