ApiLogicServer 16.1.3__py3-none-any.whl → 16.1.18__py3-none-any.whl

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

@@ -42,6 +42,13 @@ This is the **BLT Manager** - a nested workspace that gets regenerated by the Bu
 - Has its own venv shared by test projects
 - Framework changes happen in `org_git/ApiLogicServer-src/`
 
+**🚨 CRITICAL: README Files - Gold Source is Docs Repo**
+- **Gold source:** `org_git/Docs/docs/` (NOT `ApiLogicServer-src/prototypes/`)
+- **copy_md() function:** Fetches from GitHub Docs repo (or local Docs if dev), converts mkdocs → markdown
+- **Affected files:** Any file containing "readme" or "README" (readme_vibe.md, readme_ai_mcp.md, Tutorial.md, Sample-Integration.md, etc.)
+- **Implication:** Changes to README files must go to **Docs repo**, not prototypes - prototypes get overwritten on project creation
+- **See:** [Architecture-Internals.md#docs-used-in-project-creation](https://apilogicserver.github.io/Docs/Architecture-Internals/#docs-used-in-project-creation)
+
  
 
 ## 📚 Complete Architecture Documentation
@@ -440,12 +447,32 @@ Several `*_corrected_prompt.txt` files show typical AI mistakes:
 4. Sync templates back to `ApiLogicServer-src`
 5. Push to GitHub
 
+**🚨 CRITICAL Exception - README Files:**
+- **Gold source:** `org_git/Docs/docs/` - NOT ApiLogicServer-src prototypes
+- **Affected:** readme_vibe.md, readme_ai_mcp.md, Tutorial.md, Sample-Integration.md, etc.
+- **Why:** Users read docs without installing; copy_md() fetches from Docs on project creation
+- **Workflow for README changes:**
+  1. Edit in `org_git/Docs/docs/` (e.g., Sample-Basic-Demo.md)
+  2. Test locally (mkdocs serve)
+  3. Commit to Docs repo
+  4. Run BLT - copy_md() will fetch updated docs
+  5. Test generated projects have correct READMEs
+
 **BLT (Build-Load-Test):**
 - Rebuilds API Logic Server from dev source
 - Creates ~18 test projects with validation
 - Critical smoke test before pushing to GitHub
 - Results in `tests/results.txt` and `tests/failures.txt`
 
+**Propagating Changes to Source:**
+- **Copilot Instructions:** Use `system/ApiLogicServer-Internal-Dev/propagate_copilot_changes.py`
+  - Copies changes from `tests/ApiLogicProject/.github/.copilot-instructions.md` → source prototype
+  - Usage: `python3 build_and_test/ApiLogicServer/system/ApiLogicServer-Internal-Dev/propagate_copilot_changes.py`
+  - Extracts sections between title and "Key Technical Points"
+  - Ensures edits propagate to future project creations
+- **README Files:** Manual update required in Docs repo (see above)
+- **Other Files:** Copy manually or create similar propagation scripts in `system/ApiLogicServer-Internal-Dev/`
+
  
 
 ---

api_logic_server_cli/prototypes/manager/system/ApiLogicServer-Internal-Dev/propagate_copilot_changes.py

@@ -0,0 +1,102 @@
+#!/usr/bin/env python3
+"""
+Propagate Copilot Instructions Changes from BLT Test Projects to Source Prototypes
+
+Usage:
+    cd /Users/val/dev/ApiLogicServer/ApiLogicServer-dev
+    python3 build_and_test/ApiLogicServer/system/ApiLogicServer-Internal-Dev/propagate_copilot_changes.py
+
+Purpose:
+    When you edit .copilot-instructions.md in test projects (tests/ApiLogicProject),
+    this script copies those changes back to the source prototype 
+    (org_git/ApiLogicServer-src/api_logic_server_cli/prototypes/base/).
+    
+    This ensures changes propagate to future project creations.
+"""
+
+import re
+import sys
+from pathlib import Path
+
+def propagate_copilot_instructions():
+    """Copy changes from BLT test project to source prototype"""
+    
+    base_dir = Path('/Users/val/dev/ApiLogicServer/ApiLogicServer-dev')
+    
+    # Source files
+    test_file = base_dir / 'build_and_test/ApiLogicServer/tests/ApiLogicProject/.github/.copilot-instructions.md'
+    source_file = base_dir / 'org_git/ApiLogicServer-src/api_logic_server_cli/prototypes/base/.github/.copilot-instructions.md'
+    
+    if not test_file.exists():
+        print(f"❌ Test file not found: {test_file}")
+        return False
+        
+    if not source_file.exists():
+        print(f"❌ Source file not found: {source_file}")
+        return False
+    
+    # Read test file
+    with open(test_file, 'r') as f:
+        test_content = f.read()
+    
+    # Read source file
+    with open(source_file, 'r') as f:
+        source_content = f.read()
+    
+    # Extract sections to copy (between title and "Key Technical Points")
+    # This captures additions like "What You Get" and "What You Do"
+    match = re.search(
+        r'(# GitHub Copilot Instructions.*?\n---\n)(.*?)(---\n\n## 🔑 Key Technical Points)',
+        test_content,
+        re.DOTALL
+    )
+    
+    if not match:
+        print("❌ Could not find sections to copy in test file")
+        return False
+    
+    new_sections = match.group(2)
+    
+    # Replace in source file
+    updated_content = re.sub(
+        r'(# GitHub Copilot Instructions.*?\n---\n).*?(---\n\n## 🔑 Key Technical Points)',
+        r'\1' + new_sections + r'\2',
+        source_content,
+        flags=re.DOTALL
+    )
+    
+    if updated_content == source_content:
+        print("ℹ️  No changes needed - source already up to date")
+        return True
+    
+    # Write back to source
+    with open(source_file, 'w') as f:
+        f.write(updated_content)
+    
+    print("✅ Successfully updated source prototype:")
+    print(f"   {source_file.relative_to(base_dir)}")
+    print("   Changes will propagate to newly created projects after next BLT run")
+    
+    return True
+
+def propagate_readme_changes():
+    """
+    Reminder: README files have gold source in Docs repo, not prototypes.
+    
+    Changes to readme.md and readme_ai_mcp.md in test projects need to be
+    manually copied to:
+        /org_git/Docs/docs/Sample-Basic-Demo.md
+        /org_git/Docs/docs/Integration-MCP-AI-Example.md
+    """
+    print("\n📝 Reminder: README changes need manual update in Docs repo:")
+    print("   /org_git/Docs/docs/Sample-Basic-Demo.md")
+    print("   /org_git/Docs/docs/Integration-MCP-AI-Example.md")
+
+if __name__ == '__main__':
+    print("Propagating Copilot Instructions Changes...")
+    print("-" * 60)
+    
+    success = propagate_copilot_instructions()
+    propagate_readme_changes()
+    
+    sys.exit(0 if success else 1)

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_formal.prompt

@@ -2,7 +2,7 @@ Create a system with customers, orders, items and products.
 
 Include a notes field for orders.
 
-Use case: Check Credit
+on Placing Orders, Check Credit
     1. Customer.balance <= credit_limit
     2. Customer.balance = Sum(Order.amount_total where date_shipped is null)
     3. Order.amount_total = Sum(Item.amount)

api_logic_server_cli/prototypes/manager/system/genai/examples/postgres/genai_demo_pg.prompt

@@ -6,7 +6,7 @@ Include a notes field for orders.
 
 Create a few rows of only customer and product data.
 
-Enforce the Check Credit requirement (do not generate check constraints):
+Enforce on Placing Orders, Check Credit requirement (do not generate check constraints):
 1. Customer.balance <= credit_limit
 2. Customer.balance = Sum(Order.amount_total where date_shipped is null)
 3. Order.amount_total = Sum(Item.mount)

api_logic_server_cli/prototypes/manager/system/genai/reference/declare_logic.py

@@ -23,7 +23,7 @@ def declare_logic():
         
     Use Logic Bank to enforce these requirements:
     
-    Enforce the Check Credit requirement (do not generate check constraints):
+    Enforce on Placing Orders, Check Credit requirement (do not generate check constraints):
     1. Customer.balance <= credit_limit
     2. Customer.balance = Sum(Order.amount_total where date_shipped is null)
     3. Order.amount_total = Sum(Item.mount)

api_logic_server_cli/prototypes/manager/system/genai/reference/genai_demo_logic.txt

@@ -1,6 +1,6 @@
 -- informal English
 
-Use Logic Bank to enforce the Check Credit requirement (do not generate check constraints):
+Use Logic Bank to enforce on Placing Orders, Check Credit requirement (do not generate check constraints):
 1. The customer's balance must not exceed the credit limit.
 2. The customer's balance is the sum of all unshipped orders.
 3. The order amount total is the sum of all item amounts.

api_logic_server_cli/prototypes/nw/Tutorial.md

@@ -183,7 +183,7 @@ Note the automation for **automatic joins** (Product Name, not ProductId) and **
 
  
 
-### 3.b Customize Logic: Declare Check Credit Rules
+### 3.b Customize Logic: on Placing Orders, Check Credit
 
 Such logic (multi-table derivations and constraints) is a significant portion of a system, typically nearly half.  API Logic server provides **spreadsheet-like rules** that dramatically simplify and accelerate logic development.
 

api_logic_server_cli/prototypes/nw/integration/Sample-Integration.md

@@ -1,6 +1,7 @@
 ---
 title: Declarative Application Integration
-version: 10.3.0 from install
+notes: gold docsite, 2100 words (goal: 1500)
+version: 10.03.01 from docsite, for readme
 ---
 
 # Purpose
@@ -23,7 +24,8 @@ The **Northwind API Logic Server** provides APIs *and logic* for both transactio
 
 The **Shipping API Logic Server** listens on kafka, and processes the message.<br><br>
 
-![overview](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/overview.jpg?raw=true)
+![overview](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/integration.png?raw=true)
+
 &nbsp;
 
 **Self-serve APIs, Shared Logic**
@@ -84,27 +86,30 @@ To run the ApiLogicProject app:
 One command has created meaningful elements of our system:
 <br><br>
 
-!!! pied-piper ":bulb: Instant Self-Serve API - ad hoc integration - and Admin App"
 
-    ### API: Ad hoc Integration
+&nbsp;
+**Key Takeways - Instant Self-Serve API - ad hoc integration - and Admin App**
+&nbsp;
+
+### API: Ad hoc Integration
+
+The system creates an API with end points for each table, providing filtering, sorting, pagination, optimistic locking and related data access.
 
-    The system creates an API with end points for each table, providing filtering, sorting, pagination, optimistic locking and related data access.
-    
-    The API is [**self-serve**](https://apilogicserver.github.io/Docs/API-Self-Serve/): consumers can select their own attributes and related data, eliminating reliance on custom API development.  In this sample, our self-serve API meets our needs for Ad Hoc Integration, and Custom UI Dev.
+The API is [**self-serve**](https://apilogicserver.github.io/Docs/API-Self-Serve/): consumers can select their own attributes and related data, eliminating reliance on custom API development.  In this sample, our self-serve API meets our needs for Ad Hoc Integration, and Custom UI Dev.
 
-    <img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/api-swagger.jpeg?raw=true">
+<img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/api-swagger.jpeg?raw=true">
 
-    ### Admin App: Order Entry UI
+### Admin App: Order Entry UI
 
-    The `create` command also creates an Admin App: multi-page, multi-table with automatic joins -- ready for **[business user agile collaboration](https://apilogicserver.github.io/Docs/Tech-AI/),** and back office data maintenance.  This complements custom UIs you can create with the API.
+The `create` command also creates an Admin App: multi-page, multi-table with automatic joins -- ready for **[business user agile collaboration](https://apilogicserver.github.io/Docs/Tech-AI/),** and back office data maintenance.  This complements custom UIs you can create with the API.
 
-    You can click the first Customer, and see their Orders, and Items.
+You can click the first Customer, and see their Orders, and Items.
 
-    <img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/admin-app-initial.jpeg?raw=true">
+<img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/admin-app-initial.jpeg?raw=true">
 
-    !!! pied-piper ":bulb: 1 Command: Ad Hoc Integration Complete"
+!!! pied-piper ":bulb: 1 Command: Ad Hoc Integration Complete"
 
-        With 1 command, we have created an executable project that completes our ad hoc integration with a self-serve API.  We have also unblocked custom UI development.
+    With 1 command, we have created an executable project that completes our ad hoc integration with a self-serve API.  We have also unblocked custom UI development.
 
 &nbsp;
 
@@ -235,45 +240,48 @@ Note the automation for **automatic joins** (Product Name, not ProductId) and **
 
 &nbsp;
 
-### Declare Check Credit Logic
+### on Placing Orders, Check Credit Logic
 
 Such logic (multi-table derivations and constraints) is a significant portion of a system, typically nearly half.  API Logic server provides **spreadsheet-like rules** that dramatically simplify and accelerate logic development.
 
-!!! pied-piper ":bulb: Logic: Multi-table Derivation and Constraint Rules, 40X More Concise"
 
-    #### IDE: Declare and Debug
+&nbsp;
+**Key Takeways - Logic: Multi-table Derivations and Constraint Rules, 40X More Concise**
+&nbsp;
+
+#### IDE: Declare and Debug
+
+The 5 check credit rules are shown below.  
+
+!!! pied-piper ":bulb: Rules are 40X More Concise Than Code"
+
+    Rules are 40X more concise than legacy code, as [shown here](https://apilogicserver.github.io/Docs/https://github.com/ApiLogicServer/basic_demo/blob/main/logic/procedural/declarative-vs-procedural-comparison).
+
+Rules are declared in Python, simplified with IDE code completion.  The `add-cust` process above has simulated the process of using your IDE to declare logic.
 
-    The 5 check credit rules are shown below.  
+Observe rules can be debugged using standard logging and the debugger:
 
-    !!! pied-piper ":bulb: Rules are 40X More Concise Than Code"
-    
-        Rules are 40X more concise than legacy code, as [shown here](https://github.com/valhuber/LogicBank/wiki/by-code){:target="_blank" rel="noopener"}.
-    
-    Rules are declared in Python, simplified with IDE code completion.  The `add-cust` process above has simulated the process of using your IDE to declare logic.
-    
-    Observe rules can be debugged using standard logging and the debugger:
+<img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/logic-chaining.jpeg?raw=true">
 
-    <img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/logic-chaining.jpeg?raw=true">
+Rules operate by handling SQLAlchemy events, so apply to all ORM access, whether by the api engine, or your custom code.  Once declared, you don't need to remember to call them, which promotes quality.
 
-    Rules operate by handling SQLAlchemy events, so apply to all ORM access, whether by the api engine, or your custom code.  Once declared, you don't need to remember to call them, which promotes quality.
+The rules shown above prevented the too-big order with *multi-table logic* to copy the Product Price, compute the Amount, roll it up to the AmountTotal and Balance, and check the CreditLimit.  
 
-    The rules shown above prevented the too-big order with *multi-table logic* to copy the Product Price, compute the Amount, roll it up to the AmountTotal and Balance, and check the CreditLimit.  
-    
-    These same rules also govern changing orders, deleting them, picking different parts - about 9 transactions, all automated.  Implementing all this by hand would otherwise require about 200 lines of code.<br><br>
-    
-    
-    #### Agility, Quality
+These same rules also govern changing orders, deleting them, picking different parts - about 9 transactions, all automated.  Implementing all this by hand would otherwise require about 200 lines of code.<br><br>
 
-    Rules are a unique and significant innovation, providing meaningful improvements over procedural logic:
 
-    | CHARACTERISTIC | PROCEDURAL | DECLARATIVE | WHY IT MATTERS |
-    | :--- |:---|:---|:---|
-    | **Reuse** | Not Automatic | Automatic - all Use Cases | **40X Code Reduction** |
-    | **Invocation** | Passive - only if called  | Active - call not required | Quality |
-    | **Ordering** | Manual | Automatic | Agile Maintenance |
-    | **Optimizations** |Manual | Automatic | Agile Design |
+#### Agility, Quality
 
-    > For more on rules, [click here](https://apilogicserver.github.io/Docs/Logic-Why/){:target="_blank" rel="noopener"}.
+Rules are a unique and significant innovation, providing meaningful improvements over procedural logic:
+
+| CHARACTERISTIC | PROCEDURAL | DECLARATIVE | WHY IT MATTERS |
+| :--- |:---|:---|:---|
+| **Reuse** | Not Automatic | Automatic - all Use Cases | **40X Code Reduction** |
+| **Invocation** | Passive - only if called  | Active - call not required | Quality |
+| **Ordering** | Manual | Automatic | Agile Maintenance |
+| **Optimizations** |Manual | Automatic | Agile Design |
+
+> For more on rules, [click here](https://apilogicserver.github.io/Docs/Logic-Why/).
 
 &nbsp;
 
@@ -289,13 +297,16 @@ To see security in action:
 
 &nbsp;
 
-!!! pied-piper ":bulb: Row-Level Security: Customers Filtered"
 
-    #### Login, Row Filtering
+&nbsp;
+**Key Takeways - Row-Level Security: Customers Filtered**
+&nbsp;
+
+#### Login, Row Filtering
 
-    Declarative row-level security ensures that users see only the rows authorized for their roles.  Observe you now see only customer ALFKI, per the security declared below.  Note the console log at the bottom shows how the filter worked.
+Declarative row-level security ensures that users see only the rows authorized for their roles.  Observe you now see only customer ALFKI, per the security declared below.  Note the console log at the bottom shows how the filter worked.
 
-    <img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/security-filters.jpg?raw=true">
+<img src="https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/security-filters.jpg?raw=true">
 
 &nbsp;
 
@@ -328,7 +339,10 @@ The main task here is to ***map*** a B2B payload onto our logic-enabled SQLAlche
 
 ![dict to row](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/dict-to-row.jpg?raw=true)
 
-!!! pied-piper ":bulb: Custom Endpoint - 7 lines of code"
+
+&nbsp;
+**Key Takeways - Custom Endpoint - 7 lines of code**
+&nbsp;
 
     So, our custom endpoint required about 7 lines of code, along with the API specification on the right.  Note the logic is automatically factored out, and re-used for all APIs, both custom and self-serve.
 
@@ -355,7 +369,10 @@ Just as you can customize apis, you can complement rule-based logic using Python
 
 ![send order to shipping](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/integration/order-to-shipping.jpg?raw=true)
 
-!!! pied-piper ":bulb: Extensible Rules, Kafka Message Produced"
+
+&nbsp;
+**Key Takeways - Extensible Rules, Kafka Message Produced**
+&nbsp;
 
     Rule-based logic is extensible with Python, here producing a Kafka message with 20 lines of code.
 
@@ -363,7 +380,7 @@ Just as you can customize apis, you can complement rule-based logic using Python
 
 ## 4. Consuming Messages
 
-The Shipping system illustrates how to consume messages.  This system was [created from AI](Tutorial-AI.md), here customized to add message consumption.
+The Shipping system illustrates how to consume messages.  This system was [created from AI](https://apilogicserver.github.io/Docs/Tutorial-AI), here customized to add message consumption.
 
 &nbsp;
 

{apilogicserver-16.1.3.dist-info → apilogicserver-16.1.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ApiLogicServer
-Version: 16.1.3
+Version: 16.1.18
 Author-email: Val Huber <apilogicserver@gmail.com>
 License-Expression: BSD-3-Clause
 Project-URL: Homepage, https://www.genai-logic.com