ara-cli 0.1.9.93__tar.gz → 0.1.9.94__tar.gz

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ara_cli
-Version: 0.1.9.93
+Version: 0.1.9.94
 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
@@ -108,22 +108,22 @@ ara autofix
 
 ## Command Overview
 
-| Action             | Description                                                                 |
-|--------------------|-----------------------------------------------------------------------------|
-| create             | Create a classified artefact with data directory                            |
-| delete             | Delete an artefact and its data directory                                   |
-| rename             | Rename an artefact and its data directory                                   |
-| list, list-tags    | List artefacts, show tags, filter by content, extension, hierarchy etc.     |
-| prompt, chat       | Use AI-powered chat and prompt templates for artefact management            |
-| template           | Print artefact templates in the terminal                                    |
-| fetch-templates    | Download and manage reusable prompt templates                               |
-| read               | Output artefact contents and their full contribution chain                  |
-| reconnect          | Connect artefacts to parent artefacts                                       |
-| read-status, set-status | Query and assign status to artefacts                                   |
-| read-user, set-user     | Query and assign responsible users                                     |
-| classifier-directory    | Show directory of artefact classifiers                                 |
-| scan               | Scan the ARA tree for incompatible or inconsistent artefacts                |
-| autofix            | Automatically correct artefact issues with LLM assistance                   |
+| Action                  | Description                                                             |
+| ----------------------- | ----------------------------------------------------------------------- |
+| create                  | Create a classified artefact with data directory                        |
+| delete                  | Delete an artefact and its data directory                               |
+| rename                  | Rename an artefact and its data directory                               |
+| list, list-tags         | List artefacts, show tags, filter by content, extension, hierarchy etc. |
+| prompt, chat            | Use AI-powered chat and prompt templates for artefact management        |
+| template                | Print artefact templates in the terminal                                |
+| fetch-templates         | Download and manage reusable prompt templates                           |
+| read                    | Output artefact contents and their full contribution chain              |
+| reconnect               | Connect artefacts to parent artefacts                                   |
+| read-status, set-status | Query and assign status to artefacts                                    |
+| read-user, set-user     | Query and assign responsible users                                      |
+| classifier-directory    | Show directory of artefact classifiers                                  |
+| scan                    | Scan the ARA tree for incompatible or inconsistent artefacts            |
+| autofix                 | Automatically correct artefact issues with LLM assistance               |
 
 See `ara -h` for the complete list of commands and usage examples.
 

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/README.md

@@ -84,22 +84,22 @@ ara autofix
 
 ## Command Overview
 
-| Action             | Description                                                                 |
-|--------------------|-----------------------------------------------------------------------------|
-| create             | Create a classified artefact with data directory                            |
-| delete             | Delete an artefact and its data directory                                   |
-| rename             | Rename an artefact and its data directory                                   |
-| list, list-tags    | List artefacts, show tags, filter by content, extension, hierarchy etc.     |
-| prompt, chat       | Use AI-powered chat and prompt templates for artefact management            |
-| template           | Print artefact templates in the terminal                                    |
-| fetch-templates    | Download and manage reusable prompt templates                               |
-| read               | Output artefact contents and their full contribution chain                  |
-| reconnect          | Connect artefacts to parent artefacts                                       |
-| read-status, set-status | Query and assign status to artefacts                                   |
-| read-user, set-user     | Query and assign responsible users                                     |
-| classifier-directory    | Show directory of artefact classifiers                                 |
-| scan               | Scan the ARA tree for incompatible or inconsistent artefacts                |
-| autofix            | Automatically correct artefact issues with LLM assistance                   |
+| Action                  | Description                                                             |
+| ----------------------- | ----------------------------------------------------------------------- |
+| create                  | Create a classified artefact with data directory                        |
+| delete                  | Delete an artefact and its data directory                               |
+| rename                  | Rename an artefact and its data directory                               |
+| list, list-tags         | List artefacts, show tags, filter by content, extension, hierarchy etc. |
+| prompt, chat            | Use AI-powered chat and prompt templates for artefact management        |
+| template                | Print artefact templates in the terminal                                |
+| fetch-templates         | Download and manage reusable prompt templates                           |
+| read                    | Output artefact contents and their full contribution chain              |
+| reconnect               | Connect artefacts to parent artefacts                                   |
+| read-status, set-status | Query and assign status to artefacts                                    |
+| read-user, set-user     | Query and assign responsible users                                      |
+| classifier-directory    | Show directory of artefact classifiers                                  |
+| scan                    | Scan the ARA tree for incompatible or inconsistent artefacts            |
+| autofix                 | Automatically correct artefact issues with LLM assistance               |
 
 See `ara -h` for the complete list of commands and usage examples.
 

ara_cli-0.1.9.94/ara_cli/__init__.py

@@ -0,0 +1,3 @@
+from .version import __version__
+
+whitelisted_commands = ["RERUN", "SEND", "EXTRACT", "LOAD_IMAGE", "CHOOSE_MODEL", "CHOOSE_EXTRACTION_MODEL", "CURRENT_MODEL", "CURRENT_EXTRACTION_MODEL", "LIST_MODELS"]

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/ara_cli/ara_command_action.py

@@ -165,6 +165,7 @@ def prompt_action(args):
     classifier = args.classifier
     param = args.parameter
     init = args.steps
+    write = getattr(args, 'write', False)
 
     def handle_init():
         from ara_cli.prompt_handler import initialize_prompt_templates
@@ -192,7 +193,7 @@ def prompt_action(args):
     def handle_extract():
         from ara_cli.prompt_extractor import extract_and_save_prompt_results
         from ara_cli.update_config_prompt import update_artefact_config_prompt_files
-        extract_and_save_prompt_results(classifier, param)
+        extract_and_save_prompt_results(classifier, param, write=write)
         print(f"automatic update after extract")
         update_artefact_config_prompt_files(classifier, param, automatic_update=True)
 
@@ -294,53 +295,30 @@ def fetch_templates_action(args):
 
 
 def read_action(args):
-    from ara_cli.artefact_reader import ArtefactReader
-    from ara_cli.file_classifier import FileClassifier
+    from ara_cli.commands.read_command import ReadCommand
+    from ara_cli.list_filter import ListFilter
 
     classifier = args.classifier
     artefact_name = args.parameter
     read_mode = args.read_mode
 
-    file_classifier = FileClassifier(os)
-    classified_artefacts = ArtefactReader.read_artefacts()
-    artefacts = classified_artefacts.get(classifier, [])
-    all_artefact_names = [a.title for a in artefacts]
-
-    if artefact_name not in all_artefact_names:
-        suggest_close_name_matches(
-                artefact_name,
-                all_artefact_names
-            )
-        return
-
-    target_artefact = next(filter(
-        lambda x: x.title == artefact_name, artefacts
-    ))
+    list_filter = ListFilter(
+        include_content=args.include_content,
+        exclude_content=args.exclude_content,
+        include_extension=args.include_extension,
+        exclude_extension=args.exclude_extension,
+        include_tags=args.include_tags,
+        exclude_tags=args.exclude_tags
+    )
 
-    artefacts_by_classifier = {classifier: []}
+    command = ReadCommand(
+        classifier=classifier,
+        artefact_name=artefact_name,
+        read_mode=read_mode,
+        list_filter=list_filter
+    )
 
-    match read_mode:
-        case "branch":
-            ArtefactReader.step_through_value_chain(
-                artefact_name=artefact_name,
-                classifier=classifier,
-                artefacts_by_classifier=artefacts_by_classifier,
-                classified_artefacts=classified_artefacts
-            )
-            file_classifier.print_classified_files(artefacts_by_classifier, print_content=True)
-        case "children":
-            artefacts = ArtefactReader.find_children(
-                artefact_name=artefact_name,
-                classifier=classifier,
-                classified_artefacts=classified_artefacts
-            )
-            file_classifier.print_classified_files(
-                files_by_classifier=artefacts,
-                print_content=True
-            )
-        case _:
-            artefacts_by_classifier[classifier].append(target_artefact)
-            file_classifier.print_classified_files(artefacts_by_classifier, print_content=True)
+    command.execute()
 
 
 def reconnect_action(args):
@@ -615,11 +593,13 @@ def extract_action(args):
     from ara_cli.commands.extract_command import ExtractCommand
 
     filename = args.filename
-    skip_queries = args.skip_queries
+    force = args.force
+    write = getattr(args, 'write', False)
     print(filename)
     command = ExtractCommand(
         file_name=filename,
-        skip_queries=skip_queries,
+        force=force,
+        write=write,
         output=lambda msg: print(msg, file=sys.stdout),
         error_output=lambda msg: print(msg, file=sys.stderr)
     )

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/ara_cli/ara_command_parser.py

@@ -254,6 +254,13 @@ def prompt_parser(subparsers):
         ).completer = ArtefactCompleter()
         if step == "chat":
             add_chat_arguments(step_parser)
+        if step == "extract":
+            step_parser.add_argument(
+                "-w",
+                "--write",
+                action="store_true",
+                help="Overwrite existing files without using LLM for merging."
+            )
 
 
 def chat_parser(subparsers):
@@ -287,6 +294,8 @@ def read_parser(subparsers):
         "parameter", help="Filename of artefact"
     ).completer = ArtefactCompleter()
 
+    add_filter_flags(read_parser)
+
     branch_group = read_parser.add_mutually_exclusive_group()
     branch_group.add_argument(
         "-b",
@@ -429,10 +438,16 @@ def extract_parser(subparsers):
         help="Input file to extract from."
     )
     extract_parser.add_argument(
-        "--skip-queries", "-s",
+        "--force", "-f",
         action="store_true",
         help="Answer queries with yes when extracting."
     )
+    extract_parser.add_argument(
+        "-w",
+        "--write",
+        action="store_true",
+        help="Overwrite existing files without using LLM for merging."
+    )
 
 
 class CustomHelpFormatter(argparse.HelpFormatter):

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/ara_cli/artefact_lister.py

@@ -1,9 +1,13 @@
 from ara_cli.file_classifier import FileClassifier
 from ara_cli.artefact_reader import ArtefactReader
 from ara_cli.file_lister import list_files_in_directory
-from ara_cli.artefact_models.artefact_model import Artefact
 from ara_cli.list_filter import ListFilter, filter_list
 from ara_cli.artefact_fuzzy_search import suggest_close_name_matches
+from ara_cli.artefact_models.artefact_data_retrieval import (
+    artefact_content_retrieval,
+    artefact_path_retrieval,
+    artefact_tags_retrieval,
+)
 import os
 
 
@@ -11,43 +15,18 @@ class ArtefactLister:
     def __init__(self, file_system=None):
         self.file_system = file_system or os
 
-    @staticmethod
-    def artefact_content_retrieval(artefact: Artefact):
-        content = artefact.serialize()
-        return content
-
-    @staticmethod
-    def artefact_path_retrieval(artefact: Artefact):
-        return artefact.file_path
-
-    @staticmethod
-    def artefact_tags_retrieval(artefact: Artefact):
-        final_tags = []
-
-        if not artefact:
-            return []
-
-        final_tags.extend([f"user_{user}" for user in artefact.users])
-        final_tags.append(artefact.status)
-        final_tags.extend(artefact.tags)
-
-        return final_tags
-
     def filter_artefacts(self, classified_files: list, list_filter: ListFilter):
         filtered_list = filter_list(
             list_to_filter=classified_files,
             list_filter=list_filter,
-            content_retrieval_strategy=ArtefactLister.artefact_content_retrieval,
-            file_path_retrieval=ArtefactLister.artefact_path_retrieval,
-            tag_retrieval=ArtefactLister.artefact_tags_retrieval
+            content_retrieval_strategy=artefact_content_retrieval,
+            file_path_retrieval=artefact_path_retrieval,
+            tag_retrieval=artefact_tags_retrieval,
         )
         return filtered_list
 
     def list_files(
-        self,
-        tags=None,
-        navigate_to_target=False,
-        list_filter: ListFilter | None = None
+        self, tags=None, navigate_to_target=False, list_filter: ListFilter | None = None
     ):
         artefact_list = ArtefactReader.read_artefacts(tags=tags)
         artefact_list = self.filter_artefacts(artefact_list, list_filter)
@@ -60,20 +39,18 @@ class ArtefactLister:
         file_classifier.print_classified_files(filtered_artefact_list)
 
     def list_branch(
-        self,
-        classifier,
-        artefact_name,
-        list_filter: ListFilter | None = None
+        self, classifier, artefact_name, list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
         classified_artefacts = file_classifier.classify_files()
         artefact_info = classified_artefacts.get(classifier, [])
-        matching_artefact_info = [p for p in artefact_info if p["title"] == artefact_name]
+        matching_artefact_info = [
+            p for p in artefact_info if p["title"] == artefact_name
+        ]
 
         if not matching_artefact_info:
             suggest_close_name_matches(
-                artefact_name,
-                [info["title"] for info in artefact_info]
+                artefact_name, [info["title"] for info in artefact_info]
             )
 
         artefacts_by_classifier = {classifier: []}
@@ -82,29 +59,28 @@ class ArtefactLister:
             classifier=classifier,
             artefacts_by_classifier=artefacts_by_classifier,
         )
-        artefacts_by_classifier = self.filter_artefacts(artefacts_by_classifier, list_filter)
+        artefacts_by_classifier = self.filter_artefacts(
+            artefacts_by_classifier, list_filter
+        )
         file_classifier.print_classified_files(artefacts_by_classifier)
 
     def list_children(
-        self,
-        classifier,
-        artefact_name,
-        list_filter: ListFilter | None = None
+        self, classifier, artefact_name, list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
         classified_artefacts = file_classifier.classify_files()
         artefact_info = classified_artefacts.get(classifier, [])
-        matching_artefact_info = [p for p in artefact_info if p["title"] == artefact_name]
+        matching_artefact_info = [
+            p for p in artefact_info if p["title"] == artefact_name
+        ]
 
         if not matching_artefact_info:
             suggest_close_name_matches(
-                artefact_name,
-                [info["title"] for info in artefact_info]
+                artefact_name, [info["title"] for info in artefact_info]
             )
 
         child_artefacts = ArtefactReader.find_children(
-            artefact_name=artefact_name,
-            classifier=classifier
+            artefact_name=artefact_name, classifier=classifier
         )
 
         child_artefacts = self.filter_artefacts(child_artefacts, list_filter)
@@ -112,25 +88,23 @@ class ArtefactLister:
         file_classifier.print_classified_files(child_artefacts)
 
     def list_data(
-        self,
-        classifier,
-        artefact_name,
-        list_filter: ListFilter | None = None
+        self, classifier, artefact_name, list_filter: ListFilter | None = None
     ):
         file_classifier = FileClassifier(os)
         classified_artefact_info = file_classifier.classify_files()
         artefact_info_dict = classified_artefact_info.get(classifier, [])
 
-        matching_info = [info for info in artefact_info_dict if info["title"] == artefact_name]
+        matching_info = [
+            info for info in artefact_info_dict if info["title"] == artefact_name
+        ]
 
         if not matching_info:
             suggest_close_name_matches(
-                artefact_name,
-                [info["title"] for info in artefact_info_dict]
+                artefact_name, [info["title"] for info in artefact_info_dict]
             )
             return
 
         artefact_info = matching_info[0]
-        data_dir = os.path.splitext(artefact_info["file_path"])[0] + '.data'
+        data_dir = os.path.splitext(artefact_info["file_path"])[0] + ".data"
         if os.path.exists(data_dir):
             list_files_in_directory(data_dir, list_filter)

ara_cli-0.1.9.94/ara_cli/artefact_models/artefact_data_retrieval.py

@@ -0,0 +1,23 @@
+from ara_cli.artefact_models.artefact_model import Artefact
+
+
+def artefact_content_retrieval(artefact: Artefact):
+    content = artefact.serialize()
+    return content
+
+
+def artefact_path_retrieval(artefact: Artefact):
+    return artefact.file_path
+
+
+def artefact_tags_retrieval(artefact: Artefact):
+    final_tags = []
+
+    if not artefact:
+        return []
+
+    final_tags.extend([f"user_{user}" for user in artefact.users])
+    final_tags.append(artefact.status)
+    final_tags.extend(artefact.tags)
+
+    return final_tags

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/ara_cli/artefact_renamer.py

@@ -1,9 +1,10 @@
-import os
 from functools import lru_cache
 from ara_cli.classifier import Classifier
 from ara_cli.artefact_link_updater import ArtefactLinkUpdater
 from ara_cli.template_manager import DirectoryNavigator
+import os
 import re
+import warnings
 
 
 class ArtefactRenamer:
@@ -22,6 +23,8 @@ class ArtefactRenamer:
         return re.compile(pattern)
 
     def rename(self, old_name, new_name, classifier):
+        import shutil
+
         original_directory = self.navigate_to_target()
 
         if not new_name:
@@ -47,7 +50,8 @@ class ArtefactRenamer:
         if self.file_system.path.exists(new_file_path):
             raise FileExistsError(f"The new file name {new_file_path} already exists.")
         if self.file_system.path.exists(new_dir_path):
-            raise FileExistsError(f"The new directory name {new_dir_path} already exists.")
+            warnings.warn(f"The new directory name {new_dir_path} already exists. It will be replaced by the artefact's data directory or removed entirely.", UserWarning)
+            shutil.rmtree(new_dir_path)
 
         # Perform the renaming of the file and directory
         self.file_system.rename(old_file_path, new_file_path)

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/ara_cli/chat.py

@@ -9,13 +9,15 @@ from ara_cli.file_loaders.text_file_loader import TextFileLoader
 
 
 extract_parser = argparse.ArgumentParser()
-extract_parser.add_argument('-s', '--skip-queries', action='store_true', help='Force extraction')
+extract_parser.add_argument('-f', '--force', action='store_true', help='Force extraction')
+extract_parser.add_argument('-w','--write', action='store_true', help='Overwrite existing files without using LLM for merging.')
 
 load_parser = argparse.ArgumentParser()
 load_parser.add_argument('file_name', nargs='?', default='', help='File to load')
 load_parser.add_argument('--load-images', action='store_true', help='Extract and describe images from documents')
 
 
+
 class Chat(cmd2.Cmd):
     CATEGORY_CHAT_CONTROL = "Chat control commands"
     CATEGORY_LLM_CONTROL = "Language model controls"
@@ -813,7 +815,8 @@ Start chatting (type 'HELP'/'h' for available commands, 'QUIT'/'q' to exit chat
 
         command = ExtractCommand(
             file_name=self.chat_name,
-            skip_queries=args.skip_queries,
+            force=args.force,
+            write=args.write,
             output=self.poutput,
             error_output=self.perror
         )

{ara_cli-0.1.9.93 → ara_cli-0.1.9.94}/ara_cli/commands/extract_command.py

@@ -3,15 +3,16 @@ 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):
+    def __init__(self, file_name, force=False, write=False, output=None, error_output=None):
         self.file_name = file_name
-        self.skip_queries = skip_queries
+        self.force = force
+        self.write = write
         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)
+            extract_responses(self.file_name, True, force=self.force, write=self.write)
             if self.output:
                 self.output("End of extraction")
         except Exception as e:

ara_cli-0.1.9.94/ara_cli/commands/read_command.py

@@ -0,0 +1,104 @@
+from ara_cli.commands.command import Command
+from ara_cli.artefact_reader import ArtefactReader
+from ara_cli.file_classifier import FileClassifier
+from ara_cli.list_filter import ListFilter, filter_list
+from ara_cli.artefact_models.artefact_data_retrieval import (
+    artefact_content_retrieval, 
+    artefact_path_retrieval, 
+    artefact_tags_retrieval
+)
+from ara_cli.artefact_fuzzy_search import suggest_close_name_matches
+import os
+
+
+class ReadCommand(Command):
+    def __init__(
+        self,
+        classifier: str,
+        artefact_name: str,
+        read_mode: str = "default",
+        list_filter: ListFilter = None,
+        output=None
+    ):
+        self.classifier = classifier
+        self.artefact_name = artefact_name
+        self.read_mode = read_mode
+        self.list_filter = list_filter or ListFilter()
+        self.output = output or print
+
+    def execute(self) -> bool:
+        """Execute the read command and return success status."""
+        file_classifier = FileClassifier(os)
+        classified_artefacts = ArtefactReader.read_artefacts()
+        artefacts = classified_artefacts.get(self.classifier, [])
+        all_artefact_names = [a.title for a in artefacts]
+
+        if self.artefact_name not in all_artefact_names:
+            suggest_close_name_matches(
+                self.artefact_name,
+                all_artefact_names
+            )
+            return False
+
+        target_artefact = next(filter(
+            lambda x: x.title == self.artefact_name, artefacts
+        ))
+
+        artefacts_by_classifier = {self.classifier: []}
+
+        try:
+            match self.read_mode:
+                case "branch":
+                    self._handle_branch_mode(
+                        classified_artefacts, artefacts_by_classifier
+                    )
+                case "children":
+                    artefacts_by_classifier = self._handle_children_mode(
+                        classified_artefacts
+                    )
+                case _:
+                    self._handle_default_mode(
+                        target_artefact, artefacts_by_classifier
+                    )
+
+            # Apply filtering and print results
+            filtered_artefacts = self._apply_filtering(artefacts_by_classifier)
+            file_classifier.print_classified_files(
+                filtered_artefacts, print_content=True
+            )
+            return True
+
+        except Exception as e:
+            self.output(f"Error reading artefact: {e}")
+            return False
+
+    def _handle_branch_mode(self, classified_artefacts, artefacts_by_classifier):
+        """Handle branch read mode."""
+        ArtefactReader.step_through_value_chain(
+            artefact_name=self.artefact_name,
+            classifier=self.classifier,
+            artefacts_by_classifier=artefacts_by_classifier,
+            classified_artefacts=classified_artefacts
+        )
+
+    def _handle_children_mode(self, classified_artefacts):
+        """Handle children read mode."""
+        return ArtefactReader.find_children(
+            artefact_name=self.artefact_name,
+            classifier=self.classifier,
+            classified_artefacts=classified_artefacts
+        )
+
+    def _handle_default_mode(self, target_artefact, artefacts_by_classifier):
+        """Handle default read mode."""
+        artefacts_by_classifier[self.classifier].append(target_artefact)
+
+    def _apply_filtering(self, artefacts_by_classifier):
+        """Apply list filtering to artefacts."""
+        return filter_list(
+            list_to_filter=artefacts_by_classifier,
+            list_filter=self.list_filter,
+            content_retrieval_strategy=artefact_content_retrieval,
+            file_path_retrieval=artefact_path_retrieval,
+            tag_retrieval=artefact_tags_retrieval
+        )