ApiLogicServer 15.2.0__py3-none-any.whl → 15.2.3__py3-none-any.whl

api_logic_server_cli/prototypes/manager/system/ApiLogicServer-Internal-Dev/copilot-dev-context.md

@@ -75,10 +75,33 @@ This document contains **everything** you need to understand the system:
 
 ### For Creating New Projects:
 - **Manager-level `.copilot-instructions.md`** - How to CREATE projects (in workspace root)
-- Sample databases and `genai-logic create` / `genai-logic genai` commands
+  - **Location:** `prototypes/manager/.github/.copilot-instructions.md`
+  - **Size:** ~86 lines
+  - **Scope:** Creating projects ONLY (3 methods: existing DB, GenAI, new DB)
+  - **Purpose:** Instructions for creating new projects with `genai-logic create` commands
+  - **Does NOT contain:** Project customization, logic patterns, testing, security, etc.
 
 ### For Working Within Created Projects:
 - **Project-level `.copilot-instructions.md`** - How to EXTEND/CUSTOMIZE projects (auto-generated in each project)
+  - **Location:** `prototypes/base/.github/.copilot-instructions.md` (template)
+  - **Size:** ~740 lines
+  - **Scope:** Complete architecture guide for EACH created project
+  - **Purpose:** 13 Main Services (what AI can do in a project):
+    1. **Run Project** - F5 debug, `api_logic_server_run.py`
+    2. **Adding Business Logic** - Translate NL → LogicBank rules (sums, formulas, constraints, events)
+    3. **Discovery Systems** - Auto-load logic from `logic/logic_discovery/*.py`, APIs from `api/api_discovery/*.py`
+    4. **Automated Testing** - Behave tests with BLT reports (requirements traceability)
+    5. **Adding MCP** - Enable MCP client UI with `genai-logic genai-add-mcp-client`
+    6. **Configuring Admin UI** - Edit `ui/admin/admin.yaml` for customization
+    7. **Create React Apps** - `genai-logic genai-add-app` for custom UIs
+    8. **Security - RBAC** - `als add-auth` for SQL/Keycloak, `security/declare_security.py` for grants
+    9. **Custom API Endpoints** - Add routes in `api/customize_api.py`
+    10. **B2B Integration APIs** - Complex endpoints with Row Dict Mappers for partner integration
+    11. **Customize Models** - Add tables, attributes, derived fields
+    12. **Adding Events** - Row events for integrations (Kafka, webhooks, etc.)
+    13. **Critical Patterns** - React component best practices, null-safe constraints, test repeatability
+  - ⚠️ **CRITICAL:** These are TWO DIFFERENT FILES - never replace the per-project version with the manager version!
+  - 🚨 **PROPAGATION PROBLEM:** Changes to project-level instructions must be carefully copied to `prototypes/base/.github/.copilot-instructions.md`
 - **`docs/training/logic_bank_api.prompt`** - LogicBank API reference (Rosetta Stone for rules)
 - **`docs/training/testing.md`** - Behave testing guide (1755 lines, read BEFORE creating tests)
 
@@ -110,11 +133,14 @@ This document contains **everything** you need to understand the system:
 1. **Read [Architecture-Internals.md](https://apilogicserver.github.io/Docs/Architecture-Internals/)** for complete technical context
 2. Identify which documentation to consult based on task:
    - Framework development → Architecture-Internals.md
-   - Project creation → Manager-level `.copilot-instructions.md`
-   - Project customization → Project-level `.copilot-instructions.md`
+   - Project creation → Manager-level `.copilot-instructions.md` (86 lines, in prototypes/manager/)
+   - Project customization → Project-level `.copilot-instructions.md` (740 lines, in prototypes/base/)
    - Adding logic → `docs/training/logic_bank_api.prompt`
    - Creating tests → `docs/training/testing.md`
-3. When role unclear, ask: "Are you testing as a user or working on internals?"
+3. **CRITICAL:** Never confuse the two `.copilot-instructions.md` files:
+   - Manager version = how to CREATE projects (small, workspace-level)
+   - Project version = how to CUSTOMIZE projects (large, per-project with architecture details)
+4. When role unclear, ask: "Are you testing as a user or working on internals?"
 
 ### Key Principles:
 - **Assume deep technical expertise** - Technology refined over 40+ years
@@ -122,6 +148,15 @@ This document contains **everything** you need to understand the system:
 - **Respect the architecture** - Patterns represent battle-tested solutions from thousands of deployments
 - **Check training materials** - `logic_bank_api.prompt` and `testing.md` prevent common AI mistakes
 
+### Communication Tone Guidelines:
+- **Confident but NEVER hyperbolic** - Make only claims backed by specific, measurable evidence
+- **Cite concrete metrics** - "200 lines → 5 rules (40X)" not "transforms years into days"
+- **Reference historical facts** - "40+ years, 6,000+ deployments" establishes credibility
+- **Avoid unfounded superlatives** - No "revolutionary", "game-changing", or time-compression claims without data
+- **Be specific** - "Creates working API in 5 seconds" vs "drastically reduces development time"
+- **NEVER claim** - Time compression like "30-40 years → 3-4 days" - these are unmeasurable and unfounded
+- **DO claim** - Specific productivity gains with evidence: "40X code reduction", "instant API from database"
+
  
 
 ## 🔄 Development Workflow

api_logic_server_cli/prototypes/manager/system/app_model_editor/test/api_logic_server_behave/behave_logic_report.py

@@ -176,81 +176,19 @@ def main(behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
             wiki_data.append(" ")
             each_line = "## " + each_line
         if each_line.startswith("  Scenario"):
-            each_line = tab + each_line
-        if each_line.startswith("    Given") or \
-                each_line.startswith("    When") or \
-                each_line.startswith("    Then"):
-            if each_line.startswith("    Then"):
-                just_saw_then = True
-            each_line = tab + tab + each_line
-
-        each_line = each_line[:-1]
-        debug_loc = each_line.find(behave_debug_info)
-        if debug_loc > 0:
-            each_line = each_line[0 : debug_loc]
-        each_line = each_line.rstrip()
-        if "Scenario" in each_line:
+            # Extract scenario name for logic lookup
             current_scenario = each_line[18:]
             wiki_data.append(" ")
             wiki_data.append(" ")
-            wiki_data.append("### " + each_line[8:])
-
-        each_line = each_line + "  "  # wiki for "new line"
-        
-        wiki_data.append(each_line)
-
-    with open(wiki, 'w') as rpt:
-        rpt.write('\n'.join(wiki_data))
-    wiki_full_path = Path(wiki).absolute()
-    print(f'Wiki Output: {wiki_full_path}\n\n')
-
-
-
-def print_args(args, msg):
-    print(msg)
-    for each_arg in args:
-        print(f'  {each_arg}')
-    print(" ")
-
-
-@click.group()
-@click.pass_context
-def cli(ctx):
-    """
-    Combine behave.log and scenario_logic_logs to create Behave Logic Report
-
-    """
-    pass
-
-
-@cli.command("run")
-@click.pass_context
-@click.option('--behave_log',
-              default=f'logs/behave.log',  # cwd set to test/api_logic_server_behave
-              # prompt="Log from behave test suite run [behave.log]",
-              help="Help")
-@click.option('--scenario_logs',
-              default=f'logs/scenario_logic_logs',
-              # prompt="Logic Log directory from ",
-              help="Help")
-@click.option('--wiki',
-              default=f'reports/Behave Logic Report.md',
-              # prompt="Log from behave test suite run [api_logic_server_behave]",
-              help="Help")
-@click.option('--prepend_wiki',
-              default=f'reports/Behave Logic Report Intro micro.md',
-              # prompt="Log from behave test suite run [Behave Logic Report Intro]",
-              help="Help")
-def run(ctx, behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
-    main(behave_log = behave_log, scenario_logs = scenario_logs, wiki = wiki, prepend_wiki = prepend_wiki)
-
-
-if __name__ == '__main__':  # debugger & python command line start here
-    # eg: python api_logic_server_cli/cli.py create --project_name=~/Desktop/test_project
-    # unix: python api_logic_server_cli/cli.py create --project_name=/home/ApiLogicProject
-
-    print(f'\nBehave Logic Report 1.1, started at {os.getcwd()}')
-    commands = sys.argv
-    if len(sys.argv) > 1:
-        print_args(commands, f'\n\nCommand Line Arguments:')
-    cli()
+            # Remove the debug info (# features/...) from the scenario name
+            debug_loc = current_scenario.find(behave_debug_info)
+            if debug_loc > 0:
+                current_scenario = current_scenario[0:debug_loc].strip()
+            wiki_data.append(" ")
+            wiki_data.append(" ")
+            # Remove debug info from header line too
+            header_line = each_line[2:]
+            debug_loc = header_line.find(behave_debug_info)
+            if debug_loc > 0:
+                header_line = header_line[0:debug_loc].rstrip()
+            wiki_data.append("### " + header_line)  # Add scenario header

api_logic_server_cli/prototypes/manager/system/app_model_editor/test/api_logic_server_behave/behave_logic_report.py.bak

@@ -0,0 +1,256 @@
+import requests
+from pathlib import Path
+import os
+import ast
+import sys
+import click
+
+"""
+Creates wiki file from test/behave/behave.log, with rule use.
+
+Tips
+* use 2 spaces (at end) for newline
+* for tab: & emsp;
+
+"""
+
+tab = " "
+behave_debug_info = " # "
+wiki_data = []
+debug_scenario = "XXGood Order Custom Service"
+
+scenario_doc_strings = {}
+""" dict of scenario_name, array of strings """
+
+
+def remove_trailer(line: str) -> str:
+    """ remove everything after the ## """
+    end_here = line.find("\t\t##")
+    result = line[0:end_here]
+    return result
+
+def line_spacer():
+    wiki_data.append("\n")
+    wiki_data.append(" ")
+    wiki_data.append(" ")
+    wiki_data.append("\n")
+
+
+def get_current_readme(prepend_wiki: str):
+    """ initialize wiki_data with readme up to {report_name} """
+    report_name = "Behave Logic Report"
+    with open(prepend_wiki) as readme:
+        readme_lines = readme.readlines()
+    need_spacer = True
+    for each_readme_line in readme_lines:
+        if '# ' + report_name in each_readme_line:
+            need_spacer = False
+            break
+        wiki_data.append(each_readme_line[0:-1])
+    if need_spacer:
+        line_spacer()
+    wiki_data.append(f'# {report_name}')
+
+def get_truncated_scenario_name(scenario_name: str) -> str:
+    """ address max file length (chop at 26), illegal characters """
+    scenario_trunc = scenario_name
+    if scenario_trunc is not None and len(scenario_trunc) >= 26:
+        scenario_trunc = scenario_name[0:25]
+    scenario_trunc = f'{str(scenario_trunc).replace(" ", "_")}'
+    return scenario_trunc
+
+
+def show_logic(scenario: str, logic_logs_dir: str):
+    """ insert s{logic_logs_dir}/scenario.log into wiki_data as disclosure area """
+    scenario_trunc = get_truncated_scenario_name(scenario)
+    logic_file_name = f'{logic_logs_dir}/{scenario_trunc}.log'
+    logic_file_name_path = Path(logic_file_name)
+    if not logic_file_name_path.is_file():  # debug code
+        # wiki_data.append(f'unable to find Logic Log file: {logic_file_name}')
+        if scenario == debug_scenario:
+            print(f'RELATIVE: {logic_file_name} in {os.getcwd()}')
+            full_name = f'{os.getcwd()}/{logic_file_name}'
+            print(f'..FULL: {os.getcwd()}/{logic_file_name}')
+            logic_file_name = '{logic_logs_dir}/test.log'
+            with open(logic_file_name) as logic:
+                logic_lines = logic.readlines()
+    else:
+        logic_log = []
+        rules_used = []
+        wiki_data.append("<details markdown>")
+        wiki_data.append("<summary>Tests - and their logic - are transparent.. click to see Logic</summary>")
+        line_spacer()
+        scenario_trunc = get_truncated_scenario_name(scenario)
+        if scenario_trunc in scenario_doc_strings:
+            wiki_data.append(f'**Logic Doc** for scenario: {scenario}')
+            wiki_data.append("   ")
+            for each_doc_string_line in scenario_doc_strings[scenario_trunc]:
+                wiki_data.append(each_doc_string_line[0: -1])
+            line_spacer()
+        wiki_data.append(f'**Rules Used** in Scenario: {scenario}')
+        wiki_data.append("```")
+        with open(logic_file_name) as logic:
+            logic_lines = logic.readlines()
+        is_logic_log = True
+        for each_logic_line in logic_lines:
+            each_logic_line = remove_trailer(each_logic_line)
+            if is_logic_log:
+                if "Rules Fired" in each_logic_line:
+                    is_logic_log = False
+                    continue
+                else:
+                    logic_log.append(each_logic_line)
+            else:
+                if 'logic_logger - INFO' in each_logic_line:
+                    pass
+                    break
+                wiki_data.append(each_logic_line + "  ")
+        wiki_data.append("```")
+        wiki_data.append(f'**Logic Log** in Scenario: {scenario}')
+        wiki_data.append("```")
+        for each_logic_log in logic_log:
+            each_line = remove_trailer(each_logic_log)
+            wiki_data.append(each_line)
+        wiki_data.append("```")
+        wiki_data.append("</details>")
+
+
+def get_docStrings(steps_dir: str):
+    steps_dir_files = os.listdir(steps_dir)
+    indent = 4  # skip leading blanks
+    for each_steps_dir_file in steps_dir_files:
+        each_steps_dir_file_path = Path(steps_dir).joinpath(each_steps_dir_file)
+        if each_steps_dir_file_path.is_file():
+            with open(each_steps_dir_file_path) as f:
+                step_code = f.readlines()
+            # print(f'Found File: {str(each_steps_dir_file_path)}')
+            for index, each_step_code_line in enumerate(step_code):
+                if each_step_code_line.startswith('@when'):
+                    comment_start = index + 2
+                    if '"""' in step_code[comment_start]:
+                        # print(".. found doc string")
+                        doc_string_line = comment_start+1
+                        doc_string = []
+                        while (True):
+                            if '"""' in step_code[doc_string_line]:
+                                break
+                            doc_string.append(step_code[doc_string_line][indent:])
+                            doc_string_line += 1
+                        scenario_line = doc_string_line+1
+                        if 'scenario_name' not in step_code[scenario_line]:
+                            print(f'\n** Warning - scenario_name not found '\
+                                f'in file {str(each_steps_dir_file_path)}, '\
+                                f'after line {scenario_line} -- skipped')
+                        else:
+                            scenario_code_line = step_code[scenario_line]
+                            scenario_name_start = scenario_code_line.find("'") + 1
+                            scenario_name_end = scenario_code_line[scenario_name_start+1:].find("'")
+                            scenario_name = scenario_code_line[scenario_name_start: 
+                                scenario_name_end + scenario_name_start+1]
+                            if scenario_name == debug_scenario:
+                                print(f'got {debug_scenario}')
+                            scenario_trunc = get_truncated_scenario_name(scenario_name)
+                            # print(f'.... truncated scenario_name: {scenario_trunc} in {scenario_code_line}')
+                            scenario_doc_strings[scenario_trunc] = doc_string
+    # print("that's all, folks")
+
+
+def main(behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
+    """ main driver """
+    get_docStrings(steps_dir="features/steps")
+
+    get_current_readme(prepend_wiki=prepend_wiki)
+
+    contents = None
+    with open(behave_log) as f:
+        contents = f.readlines()
+
+    just_saw_then = False
+    current_scenario = ""
+    for each_line in contents:
+        if just_saw_then and each_line == "\n":
+            show_logic(scenario=current_scenario, logic_logs_dir=scenario_logs)
+        just_saw_then = False
+        if each_line.startswith("Feature"):
+            wiki_data.append("&nbsp;")
+            wiki_data.append("&nbsp;")
+            each_line = "## " + each_line
+        if each_line.startswith("  Scenario"):
+            each_line = tab + each_line
+        if each_line.startswith("    Given") or \
+                each_line.startswith("    When") or \
+                each_line.startswith("    Then"):
+            if each_line.startswith("    Then"):
+                just_saw_then = True
+            each_line = tab + tab + each_line
+
+        each_line = each_line[:-1]
+        debug_loc = each_line.find(behave_debug_info)
+        if debug_loc > 0:
+            each_line = each_line[0 : debug_loc]
+        each_line = each_line.rstrip()
+        if "Scenario" in each_line:
+            current_scenario = each_line[18:]
+            wiki_data.append("&nbsp;")
+            wiki_data.append("&nbsp;")
+            wiki_data.append("### " + each_line[8:])
+
+        each_line = each_line + "  "  # wiki for "new line"
+        
+        wiki_data.append(each_line)
+
+    with open(wiki, 'w') as rpt:
+        rpt.write('\n'.join(wiki_data))
+    wiki_full_path = Path(wiki).absolute()
+    print(f'Wiki Output: {wiki_full_path}\n\n')
+
+
+
+def print_args(args, msg):
+    print(msg)
+    for each_arg in args:
+        print(f'  {each_arg}')
+    print(" ")
+
+
+@click.group()
+@click.pass_context
+def cli(ctx):
+    """
+    Combine behave.log and scenario_logic_logs to create Behave Logic Report
+
+    """
+    pass
+
+
+@cli.command("run")
+@click.pass_context
+@click.option('--behave_log',
+              default=f'logs/behave.log',  # cwd set to test/api_logic_server_behave
+              # prompt="Log from behave test suite run [behave.log]",
+              help="Help")
+@click.option('--scenario_logs',
+              default=f'logs/scenario_logic_logs',
+              # prompt="Logic Log directory from ",
+              help="Help")
+@click.option('--wiki',
+              default=f'reports/Behave Logic Report.md',
+              # prompt="Log from behave test suite run [api_logic_server_behave]",
+              help="Help")
+@click.option('--prepend_wiki',
+              default=f'reports/Behave Logic Report Intro micro.md',
+              # prompt="Log from behave test suite run [Behave Logic Report Intro]",
+              help="Help")
+def run(ctx, behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
+    main(behave_log = behave_log, scenario_logs = scenario_logs, wiki = wiki, prepend_wiki = prepend_wiki)
+
+
+if __name__ == '__main__':  # debugger & python command line start here
+    # eg: python api_logic_server_cli/cli.py create --project_name=~/Desktop/test_project
+    # unix: python api_logic_server_cli/cli.py create --project_name=/home/ApiLogicProject
+
+    print(f'\nBehave Logic Report 1.1, started at {os.getcwd()}')
+    commands = sys.argv
+    if len(sys.argv) > 1:
+        print_args(commands, f'\n\nCommand Line Arguments:')
+    cli()

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/test/api_logic_server_behave/behave_logic_report.py

@@ -176,81 +176,19 @@ def main(behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
             wiki_data.append(" ")
             each_line = "## " + each_line
         if each_line.startswith("  Scenario"):
-            each_line = tab + each_line
-        if each_line.startswith("    Given") or \
-                each_line.startswith("    When") or \
-                each_line.startswith("    Then"):
-            if each_line.startswith("    Then"):
-                just_saw_then = True
-            each_line = tab + tab + each_line
-
-        each_line = each_line[:-1]
-        debug_loc = each_line.find(behave_debug_info)
-        if debug_loc > 0:
-            each_line = each_line[0 : debug_loc]
-        each_line = each_line.rstrip()
-        if "Scenario" in each_line:
+            # Extract scenario name for logic lookup
             current_scenario = each_line[18:]
             wiki_data.append(" ")
             wiki_data.append(" ")
-            wiki_data.append("### " + each_line[8:])
-
-        each_line = each_line + "  "  # wiki for "new line"
-        
-        wiki_data.append(each_line)
-
-    with open(wiki, 'w') as rpt:
-        rpt.write('\n'.join(wiki_data))
-    wiki_full_path = Path(wiki).absolute()
-    print(f'Wiki Output: {wiki_full_path}\n\n')
-
-
-
-def print_args(args, msg):
-    print(msg)
-    for each_arg in args:
-        print(f'  {each_arg}')
-    print(" ")
-
-
-@click.group()
-@click.pass_context
-def cli(ctx):
-    """
-    Combine behave.log and scenario_logic_logs to create Behave Logic Report
-
-    """
-    pass
-
-
-@cli.command("run")
-@click.pass_context
-@click.option('--behave_log',
-              default=f'logs/behave.log',  # cwd set to test/api_logic_server_behave
-              # prompt="Log from behave test suite run [behave.log]",
-              help="Help")
-@click.option('--scenario_logs',
-              default=f'logs/scenario_logic_logs',
-              # prompt="Logic Log directory from ",
-              help="Help")
-@click.option('--wiki',
-              default=f'reports/Behave Logic Report.md',
-              # prompt="Log from behave test suite run [api_logic_server_behave]",
-              help="Help")
-@click.option('--prepend_wiki',
-              default=f'reports/Behave Logic Report Intro micro.md',
-              # prompt="Log from behave test suite run [Behave Logic Report Intro]",
-              help="Help")
-def run(ctx, behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
-    main(behave_log = behave_log, scenario_logs = scenario_logs, wiki = wiki, prepend_wiki = prepend_wiki)
-
-
-if __name__ == '__main__':  # debugger & python command line start here
-    # eg: python api_logic_server_cli/cli.py create --project_name=~/Desktop/test_project
-    # unix: python api_logic_server_cli/cli.py create --project_name=/home/ApiLogicProject
-
-    print(f'\nBehave Logic Report 1.1, started at {os.getcwd()}')
-    commands = sys.argv
-    if len(sys.argv) > 1:
-        print_args(commands, f'\n\nCommand Line Arguments:')
-    cli()
+            # Remove the debug info (# features/...) from the scenario name
+            debug_loc = current_scenario.find(behave_debug_info)
+            if debug_loc > 0:
+                current_scenario = current_scenario[0:debug_loc].strip()
+            wiki_data.append(" ")
+            wiki_data.append(" ")
+            # Remove debug info from header line too
+            header_line = each_line[2:]
+            debug_loc = header_line.find(behave_debug_info)
+            if debug_loc > 0:
+                header_line = header_line[0:debug_loc].rstrip()
+            wiki_data.append("### " + header_line)  # Add scenario header