ara-cli 0.1.10.1__py3-none-any.whl → 0.1.11.0__py3-none-any.whl

ara_cli/templates/prompt-modules/commands/artefact_extension.commands.md

@@ -1,17 +0,0 @@
-### COMMANDS FOR EXTENDING EXISTING AGILE REQUIREMENTS ARTIFACTS
-Your job is now:
-* analyze the given files with respect to content and relationship
-* analyze the new or changed behavior with respect to content and the relationship to the existing artefacts
-* Develop formulation strategies that minimize formulation changes of existing changes.
-* generate a formulation proposal that adds the new context and or behavior for the specified documents
-* wrap and return the formulated  in the following format 
-```artefact
-# [ ] extract 
-# filename: {path/filename.filextension} 
-{formulation}
-```
-* the extract and filename statements are only allowed once per code block
-
-* Adhere strictly to established rules for AGILE PRODUCT OWNERS for high-quality specification artefacts.
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to formulate the new aretefacts" and then explain what kind of information you think is missing and how I could easily retrieve it  

ara_cli/templates/prompt-modules/commands/artefact_formulation.commands.md

@@ -1,14 +0,0 @@
-### COMMANDS FOR FORMULATING AGILE REQUIREMENTS ARTIFACTS
-Your job is now:
-* analyze the given files with respect to content and relationship
-* analyze the new artefact with respect to content and the relationship to the given files
-* generate a formulation proposal for the specified documents
-* wrap and return the formulated  in the following format 
-```artefact
-# [ ] extract 
-# filename: {path/filename.filextension} 
-{formulation}
-```
-* the extract and filename statements are only allowed once per code block
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to formulate the new artefacts" and then explain what kind of information you think is missing and how I could easily retrieve it  

ara_cli/templates/prompt-modules/commands/behave_step_generation.commands.md

@@ -1,102 +0,0 @@
-### COMMANDS FOR IMPLEMENTING A STEP IMPLEMENTATION FROM A GIVEN FEATURE FILE
-Your job is now:
-* Silently analyze the given feature file to understand the required step implementations.
-* Silently review any additionally provided source files to check if any reusable step implementations already exist or if the necessary support methods are available.
-* Develop implementation strategies that minimize code changes, prefer reusing existing methods and step definitions over new implementations. 
-* Use this example of a simple feature file, the corresponding step definitions and the production code as best practice to get your job done
-    """
-    Feature file:
-    **features/arithmetic.feature**
-    ```gherkin
-    Feature: Arithmetic Operations
-
-    Contributes to: <Any artefact name to which this feature contributes value> <Classifier of this artefact>
-
-      Scenario: Addition of two numbers
-        Given the CLI is initialized
-        When the user runs the addition command with "2" and "3"
-        Then the result should be "5"
-
-      Scenario Outline: Subtraction of two numbers
-        Given the CLI is initialized
-        When the user runs the subtraction command with "<num1>" and "<num2>"
-        Then the result should be "<result>"
-
-        Examples:
-          | num1 | num2 | result |
-          | 5    | 3    | 2      |
-          | 10   | 4    | 6      |
-          | 0    | 0    | 0      |
-    ```
-
-    Step Definitions in Python with behave as BDD test framework:
-    **features/steps/arithmetic_steps.py**
-    ```python
-    import subprocess
-    from behave import given, when, then
-
-    @given('the CLI is initialized')
-    def step_given_cli_initialized(context):
-        context.cli_command = 'python path/to/your_arithmetic_script.py'
-
-    @when('the user runs the addition command with "{num1}" and "{num2}"')
-    def step_when_user_runs_addition_command(context, num1, num2):
-        context.result = subprocess.run(
-            [context.cli_command, 'add', num1, num2],
-            capture_output=True,
-            text=True
-        ).stdout.strip()
-
-    @when('the user runs the subtraction command with "{num1}" and "{num2}"')
-    def step_when_user_runs_subtraction_command(context, num1, num2):
-        context.result = subprocess.run(
-            [context.cli_command, 'subtract', num1, num2],
-            capture_output=True,
-            text=True
-        ).stdout.strip()
-
-    @then('the result should be "{expected_result}"')
-    def step_then_result_should_be(context, expected_result):
-        assert context.result == expected_result, f"Expected {expected_result} but got {context.result}"
-    ```
-
-    CLI Script as example production code to satisfiy the interfaces defined in the step definitions (DO NOT GENERATE ANY PRODUCTION CODE NOW):
-    **your_arithmetic_script.py**
-    ```python
-    import sys
-
-    def add(a, b):
-        return int(a) + int(b)
-
-    def subtract(a, b):
-        return int(a) - int(b)
-
-    if __name__ == "__main__":
-        if len(sys.argv) != 4:
-            print("Usage: python your_arithmetic_script.py <operation> <num1> <num2>")
-            sys.exit(1)
-
-        operation = sys.argv[1]
-        num1 = sys.argv[2]
-        num2 = sys.argv[3]
-
-        if operation == 'add':
-            print(add(num1, num2))
-        elif operation == 'subtract':
-            print(subtract(num1, num2))
-        else:
-            print(f"Unknown operation: {operation}")
-            sys.exit(1)
-    ```
-    """ 
-* Systematically search and check if any of the new step definitions is already existing in any given step file. It must then be omitted in the new step definitions generation. Otherwise it will create an ambiguous steps error in the behave registry.    
-* return the generated step definitions in this format:
-```python
-# [ ] extract
-# filename: {path/filename}.py
-{python code}
-```
-
-* The extract and filename statements are only allowed once per code block.
-* Adhere strictly to established rules for high-quality Python code and architecture.
-* If essential information is missing for code generation, issue a warning: "WARNING: Information is missing to do a correct step implementation." Specify what information is lacking and suggest how it might be retrieved.

ara_cli/templates/prompt-modules/commands/code_generation_complex.commands.md

@@ -1,20 +0,0 @@
-### COMMANDS FOR IMPLEMENTING THE INTENDED GOAL
-Your job is now:
-* Silently analyze the intended behavior and draft potential new implementations in pseudo code.
-* Silently review the provided source files to understand both the current behavior and the intended new implementation.
-* Develop implementation strategies that minimize code changes, prefer reusing existing methods over new implementations.
-* Output a "change table" listing all necessary changes. Include an example line for reference:
-  | filename       | method                                   | short description of intended changes      |
-  | {filename}.py  | {method name of existing or new method}  | {detailed explanation of the changes serving as code generation prompt}      |
-
-* Implement the changes as specified in the change table, ensuring your generated code blocks are not just code snippets but at complete method levels. Use for every single generated code block this format:
-```python
-# [ ] extract
-# filename: {path/filename}.py
-{python code}
-```
-* the extract and filename statements are only allowed once per code block
-
-* Adhere strictly to established rules for high-quality Python code and architecture.
-
-* If essential information is missing for code generation, issue a warning: "WARNING: Information is missing to do a correct implementation." Specify what information is lacking and suggest how it might be retrieved.

ara_cli/templates/prompt-modules/commands/code_generation_simple.commands.md

@@ -1,13 +0,0 @@
-### COMMANDS FOR AN OBVIOUS IMPLEMENTATION THE INTENDED GOAL
-Your job is now:
-* remember you are strictly following your given RULES AS EXPERT PYTHON DEVELOPER for code and architectural code quality
-* change only code that must changed
-* Implement the code ensuring your generated code blocks are not just code snippets but at complete method levels. Use for every single generated code block this format:
-```python
-# [ ] extract
-# filename: {path/filename}.py
-{python code}
-```
-* the extract and filename statements are only allowed once per code block
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to formulate the new aretefacts" and then explain what kind of information you think is missing and how I could easily retrieve it  

ara_cli/templates/prompt-modules/commands/error_fixing.commands.md

@@ -1,20 +0,0 @@
-### COMMANDS FOR ERROR FIXING
-Your job is now to fix the error:
-* Silently analyze the described error and draft a potential solution to the fix the error
-* Silently review the provided source files to understand both the current faulty implementation and the intended changes to fix the error.
-* Develop implementation strategies that minimize code changes, prefer reusing existing methods over new implementations.
-* Output a "change table" listing all necessary changes. Include an example line for reference:
-  | filename       | method                                   | short description of intended changes      |
-  | {filename}.py  | {method name of existing or new method}  | {detailed explanation of the changes serving as code generation prompt}      |
-
-* Implement the changes as specified in the change table, ensuring your generated code blocks are not just code snippets but at complete method levels. Use for every single generated code block this format:
-```python
-# [ ] extract
-# filename: {path/filename}.py
-{python code}
-```
-* the extract and filename statements are only allowed once per code block
-
-* Adhere strictly to established rules for high-quality Python code and architecture.
-
-* If essential information is missing for code generation, issue a warning: "WARNING: Information is missing to do a correct implementation." Specify what information is lacking and suggest how it might be retrieved.

ara_cli/templates/prompt-modules/commands/feature_file_update.commands.md

@@ -1,18 +0,0 @@
-### COMMANDS FOR UPDATING THE FORMULATION OF FEATURE FILES
-Your job is now:
-* Examine the designated feature file, ensuring it aligns with the content and its relationships within the context files.
-* If there is a discrepancy between the feature's specifications and the system behavior described in the context files, defer to the behavior outlined in the context files. This also applies to behaviors not yet described in the existing feature file.
-* return a table of your five top rated proposed enhancements sorted by the "Formulation enhancement rating" and formatted in the following way (one example line is given as reference):
-| Number | filename | Scenario name | Line of feature file (from - to) | Formulation enhancement rating (0 - 1) | explanation of enhancement | 
-| 1      | file.feature  | some_scenario | 30-65                    | 0.9                             | {here comes an explanation and reasoning of the updated formulation and a reference to the context source} |
-
-* Propose a revised formulation for the feature file based on the analysis.
-* wrap and return the revised formulation in the following format 
-```artefact
-# [ ] extract 
-# filename: {path/artefac_filename.feature} 
-{formulation}
-```
-* the extract and filename statements are only allowed once per code block
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to update the formulation of the designated feature file" and then explain what kind of information you think is missing and how I could easily retrieve it  

ara_cli/templates/prompt-modules/commands/feature_formulation.commands.md

@@ -1,43 +0,0 @@
-### COMMANDS FOR FORMULATING AGILE REQUIREMENTS ARTIFACTS
-Your job is now:
-* remember your RULES
-* analyze the given files with respect to content and relationship
-* analyze the new artefact with respect to content and the relationship to the given files
-* generate a formulation proposal for the specified documents
-
-* Use this example of a simple feature file, the corresponding step definitions and the production code as best practice to get your job done
-    """
-    Feature file:
-    **features/arithmetic.feature**
-    ```gherkin
-    Feature: Arithmetic Operations
-
-    Contributes to: <Any artefact name to which this feature contributes value> <Classifier of this artefact>
-
-      Scenario: Addition of two numbers
-        Given the CLI is initialized
-        When the user runs the addition command with "2" and "3"
-        Then the result should be "5"
-
-      Scenario Outline: Subtraction of two numbers
-        Given the CLI is initialized
-        When the user runs the subtraction command with "<num1>" and "<num2>"
-        Then the result should be "<result>"
-
-        Examples:
-          | num1 | num2 | result |
-          | 5    | 3    | 2      |
-          | 10   | 4    | 6      |
-          | 0    | 0    | 0      |
-    ```
-
-* wrap and return the formulated feature in the following format 
-```artefact
-# [ ] extract 
-# filename: {path/filename.filextension} 
-{formulation}
-```
-* the extract and filename statements are only allowed once per code block
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to formulate the new artefacts" and then explain what kind of information you think is missing and how I could easily retrieve it  
-

ara_cli/templates/prompt-modules/commands/js_code_generation_simple.commands.md

@@ -1,13 +0,0 @@
-### COMMANDS FOR AN OBVIOUS IMPLEMENTATION THE INTENDED GOAL
-Your job is now:
-* remember you are strictly following your given RULES AS EXPERT JAVASCRIPT DEVELOPER for code and architectural code quality
-* change only code that must changed
-* Implement the code ensuring your generated code blocks are not just code snippets but at complete method levels. Use for every single generated code block this format:
-```js
-# [ ] extract
-# filename: {path/filename}.js
-{js code}
-```
-* the extract and filename statements are only allowed once per code block
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to formulate the new aretefacts" and then explain what kind of information you think is missing and how I could easily retrieve it  

ara_cli/templates/prompt-modules/commands/refactoring.commands.md

@@ -1,15 +0,0 @@
-### COMMANDS FOR REFACTORING
-Your job is now
-* remember you are strictly following your given RULES AS EXPERT PYTHON DEVELOPER
-* analyze again the given files with regard to the intended refactoring
-* refactor to enhance the code as indended
-* return code as fully refactored methods and not as code snippets 
-* return the code in the following format, ensuring your generated code blocks are not just code snippets but at complete method levels. Use for every single generated code block this format:
-```python
-# [ ] extract
-# filename: {path/filename}.py
-{python code}
-```
-* the extract and filename statements are only allowed once per code block
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to formulate the new aretefacts" and then explain what kind of information you think is missing and how I could easily retrieve it  

ara_cli/templates/prompt-modules/commands/refactoring_analysis.commands.md

@@ -1,9 +0,0 @@
-### COMMANDS FOR REFACTORING ANALYSIS
-Your job is now:
-* remember you are strictly following your given RULES AS EXPERT PYTHON DEVELOPER
-* analyze the intended refactoring and make a list of potential code enhancements with regard to the given files
-* return a table of your five top rated proposed enhancements sorted by the "Code enhancement rating" and formatted in the following way (one example line is given as reference):
-| Number | filename | method name | Line of code (from - to) | Code enhancement rating (0 - 1) | explanation of enhancement | 
-| 1      | file.py  | some_method | 30-65                    | 0.9                             | {here comes an explanation that on the level of a precise and detailed refactoring prompt} |
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to formulate the new aretefacts" and then explain what kind of information you think is missing and how I could easily retrieve it  

ara_cli/templates/prompt-modules/commands/reverse_engineer_feature_file.commands.md

@@ -1,15 +0,0 @@
-### COMMANDS FOR REVERSE ENGINEER A FEATURE FILE FROM EXISTING CODE
-Your job is now:
-* remember you are strictly following your given RULES AS GHERKIN EXPERT
-* Silently analyze the intended behavior of the given code and if given any other description of the program flow like pseudo code
-* do not add any additional behavior in the feature file, describe strictly the behavior that is defined by code or pseudo code
-* if any existing feature files are provided maximize reusage of formulated steps so that later step implementation effort can be reduces
-
-* return your results in the following format 
-```gherkin
-# [ ] extract
-# filename: {path/filename}.feature
-{feature file}
-```
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to correctly fullfill the job!" and then explain what kind of information you think is missing and how I could easily retrieve it.  

ara_cli/templates/prompt-modules/commands/reverse_engineer_program_flow.commands.md

@@ -1,19 +0,0 @@
-### COMMANDS FOR REVERSE ENGINEER PROGRAM FLOW FROM EXISTING CODE
-Your job is now:
-* remember you are strictly following your given RULES AS CODE ANAYLST
-* Silently analyze the intended behavior of the given code
-* create as result of your silent analysis this analysis table
-  | filename       | method                                   | short description of logical contribution to the logical program flow      |
-  | {filename}.py  | {method name, descriptive name of code block}  | {detailed explanation of the value to the program flow}      |
-
-* then generate based on your analysis and by using your generated analysis table the pseudo code that summarizes the logical flow for the whole process to generate the listing from start to end. Here is an example how the pseude code could look like:
-  ```pseudo code
-Initialize the system to prepare for use
-Verify if the user is authenticated
-IF the user is authenticated:
-    Retrieve and process user information
-ELSE:
-    Display an error message if authentication fails
-  ```
-
-* in case you think information is missing in order to generate a suffiently precise formulation, return a warning "WARNING: information is missing to correctly fullfill the job!" and then explain what kind of information you think is missing and how I could easily retrieve it.