ara-cli 0.1.9.50__py3-none-any.whl → 0.1.9.52__py3-none-any.whl

ara_cli/__main__.py

@@ -18,6 +18,7 @@ from ara_cli.ara_command_action import (
     set_status_action,
     set_user_action,
     classifier_directory_action,
+    scan_action
 )
 import argcomplete
 import sys
@@ -40,7 +41,8 @@ def define_action_mapping():
         "read-user": read_user_action,
         "set-status": set_status_action,
         "set-user": set_user_action,
-        "classifier-directory": classifier_directory_action
+        "classifier-directory": classifier_directory_action,
+        "scan": scan_action
     }
 
 

ara_cli/analyse_artefacts.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python3
+"""
+analyse_artefacts.py
+
+Walk a directory tree, try to deserialize every *.vision *.epic *.task … file
+with the appropriate Pydantic artefact model, and write the list of files that
+fail validation (plus the reason) to 'invalid_artefacts.txt'.
+"""
+
+"""
+python analyse_artefacts.py <path_to_ara_folder ex: ./ara/>
+"""
+
+from ara_cli.artefact_models import businessgoal_artefact_model, capability_artefact_model, epic_artefact_model, example_artefact_model, feature_artefact_model, issue_artefact_model, keyfeature_artefact_model, userstory_artefact_model, task_artefact_model, vision_artefact_model
+from ara_cli.artefact_models.artefact_model import Artefact, ArtefactType
+from pydantic import ValidationError
+from typing import Dict, Type, List, Tuple
+from pathlib import Path
+import os
+import sys
+
+
+# --- import your domain model ----------------------------------------------
+# Make sure this import path matches your project layout.
+# (e.g. from ara_cli.artefact_model import Artefact, ArtefactType)
+# ---------------------------------------------------------------------------
+
+
+def build_type_map() -> Dict[ArtefactType, Type[Artefact]]:
+    type_map: Dict[ArtefactType, Type[Artefact]] = {}
+    queue: List[Type[Artefact]] = list(Artefact.__subclasses__())
+    while queue:
+        cls = queue.pop()
+        try:
+            artefact_type = cls._artefact_type()
+            type_map[artefact_type] = cls
+        except Exception:
+            pass        # abstract / helper subclass
+        queue.extend(cls.__subclasses__())
+    if not type_map:
+        raise RuntimeError("No concrete Artefact subclasses found!")
+    return type_map
+
+
+def find_artefact_files(root: Path, valid_exts: List[str]) -> List[Path]:
+    return [
+        p for p in root.rglob("*")
+        if p.is_file() and p.suffix.lstrip(".") in valid_exts
+    ]
+
+
+def scan_folder(
+    root_folder: Path,
+    detailed_report: Path,
+    names_only_report: Path,
+    checklist_report: Path
+) -> Tuple[int, int]:
+    type_map = build_type_map()
+    valid_exts = [t.value for t in type_map]
+
+    artefact_files = find_artefact_files(root_folder, valid_exts)
+    bad: List[Tuple[Path, str]] = []
+
+    for file_path in artefact_files:
+        artefact_type = ArtefactType(file_path.suffix.lstrip("."))
+        artefact_cls = type_map[artefact_type]
+        text = file_path.read_text(encoding="utf-8")
+
+        try:
+            artefact_cls.deserialize(text)
+        except (ValidationError, ValueError, AssertionError) as e:
+            bad.append((file_path, str(e)))
+        except Exception as e:
+            bad.append((file_path, f"Unexpected error: {e!r}"))
+
+    # ───────────── write reports ────────────────────────────────────────────
+    if bad:
+        # 1) detailed txt
+        with detailed_report.open("w", encoding="utf-8") as f:
+            f.write("Invalid artefacts (file  →  reason)\n\n")
+            for path, err in bad:
+                f.write(f"{path}  -->  {err}\n")
+
+        # 2) names-only txt
+        with names_only_report.open("w", encoding="utf-8") as f:
+            for path, _ in bad:
+                f.write(f"{path}\n")
+
+        # 3) markdown checklist
+        with checklist_report.open("w", encoding="utf-8") as f:
+            f.write("# 📋 Artefact-fix checklist\n\n")
+            f.write("Tick a box once you’ve fixed & validated the file.\n\n")
+            for path, err in bad:
+                f.write(f"- [ ] `{path}` – {err}\n")
+
+        print(
+            f"\nFinished. {len(bad)}/{len(artefact_files)} files are invalid."
+            f"\nReports generated:"
+            f"\n • {detailed_report}"
+            f"\n • {names_only_report}"
+            f"\n • {checklist_report}"
+        )
+    else:
+        print(f"\nFinished. All {len(artefact_files)} artefacts are valid ✔️")
+        # clean up stale files from previous runs
+        for p in (detailed_report, names_only_report, checklist_report):
+            if p.exists():
+                p.unlink()
+
+    return len(artefact_files), len(bad)
+
+
+# ─────────────────────────────── main ──────────────────────────────────────
+def main() -> None:
+    if len(sys.argv) < 2:
+        print("Usage:  python scan_artefacts.py  <folder_to_scan>")
+        sys.exit(1)
+
+    root_folder = Path(sys.argv[1]).expanduser().resolve()
+    if not root_folder.is_dir():
+        print(f"Error: '{root_folder}' is not a directory.")
+        sys.exit(1)
+
+    scan_folder(
+        root_folder=root_folder,
+        detailed_report=Path("invalid_artefacts.txt"),
+        names_only_report=Path("invalid_artefact_names.txt"),
+        checklist_report=Path("invalid_artefacts_checklist.md"),
+    )
+
+
+if __name__ == "__main__":
+    main()

ara_cli/ara_command_action.py

@@ -269,7 +269,6 @@ def fetch_templates_action(args):
 
 def read_action(args):
     from ara_cli.artefact_reader import ArtefactReader
-    from ara_cli.artefact import Artefact
     from ara_cli.file_classifier import FileClassifier
 
     classifier = args.classifier
@@ -277,17 +276,22 @@ def read_action(args):
     read_mode = args.read_mode
 
     file_classifier = FileClassifier(os)
-    classified_artefacts = file_classifier.classify_files()
-    all_artefact_names = [artefact.file_name for artefact in classified_artefacts.get(classifier, [])]
+    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)
+        suggest_close_name_matches(
+                artefact_name,
+                all_artefact_names
+            )
         return
 
-    content, file_path = ArtefactReader.read_artefact(artefact_name=artefact_name, classifier=classifier)
+    target_artefact = next(filter(
+        lambda x: x.title == artefact_name, artefacts
+    ))
 
     artefacts_by_classifier = {classifier: []}
-    file_classifier = FileClassifier(os)
-    classified_artefacts = file_classifier.classify_files()
 
     match read_mode:
         case "branch":
@@ -309,83 +313,78 @@ def read_action(args):
                 print_content=True
             )
         case _:
-            artefact = Artefact.from_content(content)
-            artefact_path = next((classified_artefact.file_path for classified_artefact in classified_artefacts.get(classifier, []) if classified_artefact.name == artefact.name), artefact)
-            artefact._file_path = artefact_path
-            artefacts_by_classifier[classifier].append(artefact)
+            artefacts_by_classifier[classifier].append(target_artefact)
             file_classifier.print_classified_files(artefacts_by_classifier, print_content=True)
 
 
 def reconnect_action(args):
-    from ara_cli.artefact import Artefact
+    from ara_cli.artefact_models.artefact_load import artefact_from_content
+    from ara_cli.artefact_models.artefact_model import Contribution
     from ara_cli.artefact_reader import ArtefactReader
-    from ara_cli.file_classifier import FileClassifier
-    from ara_cli.directory_navigator import DirectoryNavigator
 
     classifier = args.classifier
     artefact_name = args.parameter
     parent_classifier = args.parent_classifier
     parent_name = args.parent_name
 
-    file_classifier = FileClassifier(os)
-    classified_artefacts = file_classifier.classify_files()
+    read_error_message = f"Could not connect {classifier} '{artefact_name}' to {parent_classifier} '{parent_name}'"
 
-    all_artefact_names = [artefact.file_name for artefact in classified_artefacts.get(classifier, [])]
-    if artefact_name not in all_artefact_names:
-        suggest_close_name_matches(artefact_name, all_artefact_names)
-        return
-
-    all_artefact_names = [artefact.file_name for artefact in classified_artefacts.get(parent_classifier, [])]
-    if parent_name not in all_artefact_names:
-        suggest_close_name_matches(parent_name, all_artefact_names)
-        return
-
-    directory_navigator = DirectoryNavigator()
-    original_directory = directory_navigator.navigate_to_target()
-
-    content, file_path = ArtefactReader.read_artefact(
+    content, artefact_info = ArtefactReader.read_artefact(
         artefact_name=artefact_name,
         classifier=classifier
     )
+    if not content:
+        print(read_error_message)
+        return
 
-    parent_content, parent_path = ArtefactReader.read_artefact(
+    parent_content, parent_info = ArtefactReader.read_artefact(
         artefact_name=parent_name,
         classifier=parent_classifier
     )
+    if not parent_content:
+        print(read_error_message)
+        return
 
-    artefact = Artefact.from_content(
+    artefact = artefact_from_content(
         content=content,
-        file_path=file_path
-    )
-    parent = Artefact.from_content(
-        content=parent_content,
-        file_path=parent_path
     )
+    artefact._file_path = artefact_info["file_path"]
 
-    artefact._parent = parent
-    artefact.write_to_file()
+    parent = artefact_from_content(
+        content=parent_content
+    )
 
-    os.chdir(original_directory)
+    artefact.contribution = Contribution(
+        artefact_name=parent.title,
+        classifier=parent.artefact_type
+    )
+    with open(artefact.file_path, 'w') as file:
+        artefact_content = artefact.serialize()
+        file.write(artefact_content)
 
 
 def read_status_action(args):
-    from ara_cli.artefact_models.artefact_load import artefact_from_content
-    from ara_cli.artefact_reader import ArtefactReader
     from ara_cli.file_classifier import FileClassifier
+    from ara_cli.artefact_models.artefact_load import artefact_from_content
 
     classifier = args.classifier
     artefact_name = args.parameter
 
     file_classifier = FileClassifier(os)
-    classified_artefacts = file_classifier.classify_files()
+    artefact_info = file_classifier.classify_files()
+    artefact_info_dicts = artefact_info.get(classifier, [])
 
-    all_artefact_names = [artefact.file_name for artefact in classified_artefacts.get(classifier, [])]
+    all_artefact_names = [artefact_info["title"] for artefact_info in artefact_info_dicts]
     if artefact_name not in all_artefact_names:
         suggest_close_name_matches(artefact_name, all_artefact_names)
         return
 
-    content, file_path = ArtefactReader.read_artefact(artefact_name=artefact_name, classifier=classifier)
+    artefact_info = next(filter(
+        lambda x: x["title"] == artefact_name, artefact_info_dicts
+    ))
 
+    with open(artefact_info["file_path"], 'r') as file:
+        content = file.read()
     artefact = artefact_from_content(content)
 
     status = artefact.status
@@ -398,21 +397,26 @@ def read_status_action(args):
 
 def read_user_action(args):
     from ara_cli.artefact_models.artefact_load import artefact_from_content
-    from ara_cli.artefact_reader import ArtefactReader
     from ara_cli.file_classifier import FileClassifier
 
     classifier = args.classifier
     artefact_name = args.parameter
 
     file_classifier = FileClassifier(os)
-    classified_artefacts = file_classifier.classify_files()
+    artefact_info = file_classifier.classify_files()
+    artefact_info_dicts = artefact_info.get(classifier, [])
 
-    all_artefact_names = [artefact.file_name for artefact in classified_artefacts.get(classifier, [])]
+    all_artefact_names = [artefact_info["title"] for artefact_info in artefact_info_dicts]
     if artefact_name not in all_artefact_names:
         suggest_close_name_matches(artefact_name, all_artefact_names)
         return
 
-    content, _ = ArtefactReader.read_artefact(artefact_name=artefact_name, classifier=classifier)
+    artefact_info = next(filter(
+        lambda x: x["title"] == artefact_name, artefact_info_dicts
+    ))
+
+    with open(artefact_info["file_path"], 'r') as file:
+        content = file.read()
     artefact = artefact_from_content(content)
 
     user_tags = artefact.users
@@ -427,8 +431,6 @@ def read_user_action(args):
 def set_status_action(args):
     from ara_cli.artefact_models.artefact_model import ALLOWED_STATUS_VALUES
     from ara_cli.artefact_models.artefact_load import artefact_from_content
-    from ara_cli.directory_navigator import DirectoryNavigator
-    from ara_cli.artefact_reader import ArtefactReader
     from ara_cli.file_classifier import FileClassifier
 
     status_tags = ALLOWED_STATUS_VALUES
@@ -443,36 +445,34 @@ def set_status_action(args):
     check_validity(new_status in status_tags, "Invalid status provided. Please provide a valid status.")
 
     file_classifier = FileClassifier(os)
-    classified_artefacts = file_classifier.classify_files()
-    all_artefact_names = [artefact.file_name for artefact in classified_artefacts.get(classifier, [])]
+    classified_artefacts_info = file_classifier.classify_files()
+    classified_artefact_dict = classified_artefacts_info.get(classifier, [])
+    all_artefact_names = [artefact_info["title"] for artefact_info in classified_artefact_dict]
 
     if artefact_name not in all_artefact_names:
         suggest_close_name_matches(artefact_name, all_artefact_names)
         return
 
-    content, file_path = ArtefactReader.read_artefact(artefact_name=artefact_name, classifier=classifier)
-
-    directory_navigator = DirectoryNavigator()
-    original_directory = directory_navigator.navigate_to_target()
+    artefact_info = next(filter(
+        lambda x: x["title"] == artefact_name, classified_artefact_dict
+    ))
 
+    with open(artefact_info["file_path"], 'r') as file:
+        content = file.read()
     artefact = artefact_from_content(content)
+
     artefact.status = new_status
 
     serialized_content = artefact.serialize()
-    with open(f"{file_path}", 'w') as file:
+    with open(f"{artefact_info['file_path']}", 'w') as file:
         file.write(serialized_content)
 
-    os.chdir(original_directory)
-
     print(f"Status of task '{artefact_name}' has been updated to '{new_status}'.")
 
 
 def set_user_action(args):
-    from ara_cli.artefact import Artefact
-    from ara_cli.artefact_reader import ArtefactReader
     from ara_cli.file_classifier import FileClassifier
-
-    user_prefix = "user_"
+    from ara_cli.artefact_models.artefact_load import artefact_from_content
 
     classifier = args.classifier
     artefact_name = args.parameter
@@ -482,27 +482,28 @@ def set_user_action(args):
         new_user = new_user.lstrip('@')
 
     file_classifier = FileClassifier(os)
-    classified_artefacts = file_classifier.classify_files()
-    all_artefact_names = [artefact.file_name for artefact in classified_artefacts.get(classifier, [])]
+    classified_artefacts_info = file_classifier.classify_files()
+    classified_artefact_dict = classified_artefacts_info.get(classifier, [])
+    all_artefact_names = [artefact_info["title"] for artefact_info in classified_artefact_dict]
 
     if artefact_name not in all_artefact_names:
         suggest_close_name_matches(artefact_name, all_artefact_names)
         return
 
-    content, file_path = ArtefactReader.read_artefact(artefact_name=artefact_name, classifier=classifier)
-    artefact = Artefact.from_content(content)
-    artefact_path = next((classified_artefact.file_path for classified_artefact in classified_artefacts.get(classifier, []) if classified_artefact.name == artefact.name), artefact.file_path)
-    artefact._file_path = artefact_path
-
-    current_tags = artefact.tags
+    artefact_info = next(filter(
+        lambda x: x["title"] == artefact_name, classified_artefact_dict
+    ))
 
-    current_tags = {tag for tag in current_tags if not tag.startswith(user_prefix)}
+    with open(artefact_info["file_path"], 'r') as file:
+        content = file.read()
+    artefact = artefact_from_content(content)
 
-    current_tags.add(f"{user_prefix}{new_user}")
+    artefact.users = [new_user]
 
-    artefact._tags = set(current_tags)
+    serialized_content = artefact.serialize()
 
-    artefact.write_to_file()
+    with open(artefact_info["file_path"], 'w') as file:
+        file.write(serialized_content)
 
     print(f"User of task '{artefact_name}' has been updated to '{new_user}'.")
 
@@ -513,3 +514,17 @@ def classifier_directory_action(args):
     classifier = args.classifier
     subdirectory = Classifier.get_sub_directory(classifier)
     print(subdirectory)
+
+
+def scan_action(args):
+    from ara_cli.file_classifier import FileClassifier
+    from ara_cli.artefact_scan import find_invalid_files, show_results
+    import os
+
+    classified_artefact_info = FileClassifier(os).classify_files()
+    invalid_artefacts = {}
+    for classifier in classified_artefact_info:
+        invalid = find_invalid_files(classified_artefact_info, classifier)
+        if invalid:
+            invalid_artefacts[classifier] = invalid
+    show_results(invalid_artefacts)

ara_cli/ara_command_parser.py

@@ -215,6 +215,10 @@ def classifier_directory_parser(subparsers):
     classifier_directory_parser.add_argument("classifier", choices=classifiers, help="Classifier of the artefact type")
 
 
+def scan_parser(subparsers):
+    subparsers.add_parser("scan", help="Scan ARA tree for incompatible artefacts.")
+
+
 class CustomHelpFormatter(argparse.HelpFormatter):
     def format_help(self):
         from sys import argv
@@ -301,5 +305,6 @@ def action_parser():
     set_status_parser(subparsers)
     set_user_parser(subparsers)
     classifier_directory_parser(subparsers)
+    scan_parser(subparsers)
 
     return parser

ara_cli/ara_config.py

@@ -11,51 +11,76 @@ DEFAULT_CONFIG_LOCATION = "./ara/.araconfig/ara_config.json"
 
 
 class ARAconfig(BaseModel):
-    ext_code_dirs: List[Dict[str, str]] = [{"source_dir_1": "./src"}, {"source_dir_2": "./tests"}]
+    ext_code_dirs: List[Dict[str, str]] = [
+        {"source_dir_1": "./src"},
+        {"source_dir_2": "./tests"},
+    ]
     glossary_dir: str = "./glossary"
     doc_dir: str = "./docs"
     local_prompt_templates_dir: str = "./ara/.araconfig"
     local_ara_templates_dir: str = "./ara/.araconfig/templates/"
     ara_prompt_given_list_includes: List[str] = [
-        "*.businessgoal", "*.vision", "*.capability", "*.keyfeature",
-        "*.epic", "*.userstory", "*.example", "*.feature", "*.task", "*.py", "*.md", "*.png", "*.jpg", "*.jpeg"
+        "*.businessgoal",
+        "*.vision",
+        "*.capability",
+        "*.keyfeature",
+        "*.epic",
+        "*.userstory",
+        "*.example",
+        "*.feature",
+        "*.task",
+        "*.py",
+        "*.md",
+        "*.png",
+        "*.jpg",
+        "*.jpeg",
     ]
     llm_config: Dict[str, Dict[str, Union[str, float]]] = {
-        "gpt-4o":
-            {
-                "provider": "openai",
-                "model": "openai/gpt-4o",
-                "temperature": 0.8
-            },
+        "gpt-4o": {
+            "provider": "openai",
+            "model": "openai/gpt-4o",
+            "temperature": 0.8
+        },
         "gpt-4.5-preview": {
             "provider": "openai",
             "model": "openai/gpt-4.5-preview",
-            "temperature": 0.8
+            "temperature": 0.8,
+        },
+        "o3-mini": {
+            "provider": "openai",
+            "model": "openai/o3-mini",
+            "temperature": 1.0,
+        },
+        "claude-3.7": {
+            "provider": "anthropic",
+            "model": "anthropic/claude-3-7-sonnet-20250219",
+            "temperature": 0.8,
+        },
+        "together-ai-llama-2": {
+            "provider": "together_ai",
+            "model": "together_ai/togethercomputer/llama-2-70b",
+            "temperature": 0.8,
+        },
+        "groq-llama-3": {
+            "provider": "groq",
+            "model": "groq/llama3-70b-8192",
+            "temperature": 0.8,
+        },
+        "opus-4": {
+            "provider": "anthropic",
+            "model": "anthropic/claude-opus-4-20250514",
+            "temperature": 0.8,
+        },
+        "sonnet-3.7": {
+            "provider": "anthropic",
+            "model": "anthropic/claude-3-7-sonnet-20250219",
+            "temperature": 0.8,
+        },
+        "sonnet-4": {
+            "provider": "anthropic",
+            "model": "anthropic/claude-sonnet-4-20250514",
+            "temperature": 0.8,
         },
-        "o3-mini":
-            {
-                "provider": "openai",
-                "model": "openai/o3-mini",
-                "temperature": 1.0
-            },
-        "claude-3.7":
-            {
-                "provider": "anthropic",
-                "model": "anthropic/claude-3-7-sonnet-20250219",
-                "temperature": 0.8
-            },
-        "together-ai-llama-2":
-            {
-                "provider": "together_ai",
-                "model": "together_ai/togethercomputer/llama-2-70b",
-                "temperature": 0.8
-            },
-        "groq-llama-3":
-            {
-                "provider": "groq",
-                "model": "groq/llama3-70b-8192",
-                "temperature": 0.8
-            }
     }
     default_llm: Optional[str] = "gpt-4o"
 
@@ -70,7 +95,7 @@ def ensure_directory_exists(directory: str):
 
 
 def validate_config_data(filepath: str):
-    with open(filepath, 'r') as file:
+    with open(filepath, "r") as file:
         data = json.load(file)
     return data
 
@@ -82,10 +107,12 @@ def read_data(filepath: str) -> ARAconfig:
         # If file does not exist, create it with default values
         default_config = ARAconfig()
 
-        with open(filepath, 'w') as file:
+        with open(filepath, "w") as file:
             json.dump(default_config.model_dump(), file, indent=4)
 
-        print(f"ara-cli configuration file '{filepath}' created with default configuration. Please modify it as needed and re-run your command")
+        print(
+            f"ara-cli configuration file '{filepath}' created with default configuration. Please modify it as needed and re-run your command"
+        )
         exit()  # Exit the application
 
     data = validate_config_data(filepath)
@@ -94,7 +121,7 @@ def read_data(filepath: str) -> ARAconfig:
 
 # Function to save the modified configuration back to the JSON file
 def save_data(filepath: str, config: ARAconfig):
-    with open(filepath, 'w') as file:
+    with open(filepath, "w") as file:
         json.dump(config.dict(), file, indent=4)
 
 

ara_cli/artefact_creator.py

@@ -2,9 +2,9 @@ import os
 from functools import lru_cache
 from ara_cli.classifier import Classifier
 from ara_cli.template_manager import DirectoryNavigator
-from ara_cli.artefact import Artefact
+from ara_cli.artefact_reader import ArtefactReader
+from ara_cli.artefact_models.artefact_model import Artefact
 from ara_cli.artefact_models.artefact_templates import template_artefact_of_type
-from ara_cli.file_classifier import FileClassifier
 from ara_cli.artefact_fuzzy_search import suggest_close_name_matches
 from pathlib import Path
 from shutil import copyfile
@@ -75,8 +75,7 @@ class ArtefactCreator:
         return True
 
     def set_artefact_parent(self, artefact, parent_classifier, parent_file_name) -> Artefact:
-        file_classifier = FileClassifier(os)
-        classified_artefacts = file_classifier.classify_files()
+        classified_artefacts = ArtefactReader.read_artefacts()
         if parent_classifier not in classified_artefacts:
             return artefact
         artefact_list = classified_artefacts[parent_classifier]