ApiLogicServer 15.0.52__py3-none-any.whl → 15.0.55__py3-none-any.whl

api_logic_server_cli/api_logic_server.py

@@ -12,9 +12,10 @@ ApiLogicServer CLI: given a database url, create [and run] customizable ApiLogic
 Called from api_logic_server_cli.py, by instantiating the ProjectRun object.
 '''
 
-__version__ = "15.00.52"  # last public release: 15.00.47 (15.00.12)
+__version__ = "15.00.55"  # last public release: 15.00.52 (15.00.12)
 recent_changes = \
     f'\n\nRecent Changes:\n' +\
+    "\t07/23/2024 - 15.00.55: system vibe support - initial testing \n"\
     "\t07/20/2024 - 15.00.52: Python 3.13 compatibility fixes - psycopg2→psycopg3, SQLAlchemy 2.0+, pkg_resources→importlib.metadata.  mgr dbs \n"\
     "\t07/17/2024 - 15.00.49: venv fix+, ext bldr * fix, copilot vibe tweaks - creation, mcp logic, basic_demo autonums \n"\
     "\t07/10/2024 - 15.00.41: copilot vibe support for logic, UI, MCP,  bug[98] \n"\
@@ -384,12 +385,14 @@ def create_project_and_overlay_prototypes(project: 'ProjectRun', msg: str) -> st
                 joinpath('prototypes/BudgetApp')
             recursive_overwrite(nw_dir, project.project_directory)
 
-        if project.db_url in ["basic_demo"]:
+        if 'basic_demo' in project.db_url:
             log.debug(".. ..Copy in basic_demo customizations: readme, logic, tests")
             nw_dir = (Path(api_logic_server_dir_str)).\
                 joinpath('prototypes/basic_demo')
             recursive_overwrite(nw_dir, project.project_directory)
-            create_utils.copy_md(project = project, from_doc_file = "Sample-Basic-Demo.md")
+            os.rename(project.project_directory_path / 'readme.md', project.project_directory_path / 'readme_standard.md')
+            create_utils.copy_md(project = project, from_doc_file = "Sample-Basic-Demo.md", to_project_file = "readme.md")
+            create_utils.copy_md(project = project, from_doc_file = "Sample-Basic-Demo-Vibe.md", to_project_file="readme_vibe.md")
 
 
         if project.db_url == "mysql+pymysql://root:p@localhost:3306/classicmodels":

api_logic_server_cli/api_logic_server_info.yaml

@@ -1,3 +1,3 @@
-last_created_date: July 20, 2025 08:02:02
-last_created_project_name: samples/nw_sample_nocust
-last_created_version: 15.00.52
+last_created_date: July 23, 2025 21:48:33
+last_created_project_name: ../../../servers/basic_demo
+last_created_version: 15.00.54

api_logic_server_cli/create_from_model/api_logic_server_utils.py

@@ -146,6 +146,7 @@ def copy_md(project, from_doc_file: str, to_project_file: str = "README.md"):
             readme_lines_mkdocs = readme_file.readlines()    
         readme_lines_md = []
         in_mkdocs_block = False
+        do_process_code_block_titles = False
         db_line_num = 0
         for each_line in readme_lines_mkdocs:
             db_line_num += 1
@@ -197,6 +198,14 @@ def copy_md(project, from_doc_file: str, to_project_file: str = "README.md"):
                     else:
                         each_line = each_line.replace('.md', '')  # hmm... todo: find out why this exists
                     pass
+                if 'process_code_block_titles' in each_line:  # update front matter to get this
+                    do_process_code_block_titles = True
+                if do_process_code_block_titles and 'title=' in each_line:
+                    # extract the quoted text after 'title=' into title
+                    match = re.search(r'title\s*=\s*["\']([^"\']+)["\']', each_line)
+                    if match:
+                        title = match.group(1)
+                    readme_lines_md.append('**' + title + ':**\n')
                 readme_lines_md.append(each_line)
         with open(str(to_file), "w") as readme_file:
             readme_file.writelines(readme_lines_md)

api_logic_server_cli/prototypes/base/.github/.copilot-instructions.md

@@ -37,11 +37,14 @@ python api_logic_server_run.py
 Rule.sum(derive=Customer.Balance, as_sum_of=Order.AmountTotal)
 Rule.constraint(validate=Customer, as_condition=lambda row: row.Balance <= row.CreditLimit)
 ```
+
+As described in `docs/training/logic_bank_api.prompt`, logic includes rules for sums, formulas, constraints, and more.  They also include events, which are used to trigger actions like sending emails or updating related records.
+
 For project `basic_demo`, the best place to begin is to provide CoPilot with the natural language logic below.  CoPilot will then offer to translate the logic into LogicBank rules. Also 
 1. Provide the analysis (below) showing the 44X code reduction.
 2. Stress the importance of business logic - it's half the project, and requires an underlying rules engine.  Using AI alone is not sufficient - you will wind up with procedural code, with the issues noted in the analysis below.
 
-Here's the natural language logic to provide to CoPilotP
+Here's the natural language logic to provide to CoPilot:
 
 ```text
 Use case: Check Credit    
@@ -79,25 +82,12 @@ but you can also offer to suggest rules.
 
 ### Adding MCP
 
-The API is automatically MCP-enabled.
-
-> **Important**: For project `basic_demo` (only), add customizations first, then MCP Client, then fix logic:
+The API is automatically MCP-enabled.  This adds the MCP Client:
 
 ```bash
-# 1. Add customization framework (required first, *only* for project `basic_demo`
-#   This creates the SysEmail table, and the logic for opt-out.
-genai-logic add-cust
-
-# 2. Then add MCP Client (requires OpenAI key)
 genai-logic genai-add-mcp-client
-
-# 3. Rename the logic file `logic/logic_discovery/use_case.py` to `logic/logic_discovery/use_case.py.duplicate` (it is duplicated by using `genai-logic add-cust`)
-rm 
 ```
 
-
-**Note**: If you already ran `genai-add-mcp-client`, you should run `add-cust` afterwards to ensure the customization framework is properly set up.
-
 ### Configuring Admin UI
 
 This is built when project is created - no need to add it.
@@ -126,6 +116,8 @@ Then, `npm install` and `npm start`
 
 Temporary restriction: security must be disabled.
 
+**IMPORTANT**: When working with React apps, ALWAYS read `docs/training` first. This file contains critical data access provider configuration that was built when the project was created. The data provider handles JSON:API communication and record context - ignore this at your peril.
+
 Customize using CoPilot chat, with `docs/training`.
 
 ### Security - Role-Based Access Control
@@ -164,9 +156,18 @@ def my_endpoint():
     return {"message": "Custom endpoint"}
 ```
 
-### Customize Models - Add Attributes
+### Customize Models - Add Tables, Attributes
+
+To add tables / columns to the database (highly impactful - request permission):
+
+1. Update `database/model.py`
+2. Use `database/alembic/alembic_run.py` to update the database.  This will generate a migration script and apply it to the database, so you do not have to run `alembic revision --autogenerate` manually. 
+3. Offer to update ui/admin/admin.yaml to add the new table or column to the Admin UI.
+
+NEVER start by  updating the database directly, since some platforms may not have database CLI tools, although you can present this as an option.
+
+If altering `database/models.py`, be sure to follow the patterns shown in the existing models.  Note they do not contain a `__bind_key__`.
 
-Update the model, and use `database/alembic` to update the database (highly impactful - request permission).
 
 ### Addressing `Missing Attributes` during logic loading at project startup
 
@@ -211,10 +212,37 @@ models.Employee.ProperSalary = __proper_salary__
 
 When customizing SQLAlchemy models:
 
-Don't use direct comparisons with database fields in computed properties
-Convert to Python values first using float(), int(), str()
-Use property() function instead of @jsonapi_attr for computed properties
-Always add error handling for type conversions
+* Don't use direct comparisons with database fields in computed properties
+* Convert to Python values first using float(), int(), str()
+* Use property() function instead of @jsonapi_attr for computed properties
+* Always add error handling for type conversions
+
+### Adding events
+LogicBank rules are the preferred approach to logic, but you will sometimes need to add events.  This is done in `logic/declare_logic.py` (important: the function MUST come first):
+
+```python
+# Example: Log email activity after SysEmail is committed
+
+def sys_email_after_commit(row: models.SysEmail, old_row: models.SysEmail, logic_row: LogicRow):
+    """
+    After SysEmail is committed, log 'email sent' 
+    unless the customer has opted out
+    """
+    if not row.customer.email_opt_out:
+        logic_row.log(f"📧 Email sent to {row.customer.name} - Subject: {row.subject}")
+    else:
+        logic_row.log(f"🚫 Email blocked for {row.customer.name} - Customer opted out")
+
+Rule.commit_row_event(on_class=SysEmail, calling=sys_email_after_commit)
+```
+
+LogicBank event types include:
+- `Rule.commit_row_event()` - fires after transaction commits
+- `Rule.after_insert()` - fires after row insert
+- `Rule.after_update()` - fires after row update  
+- `Rule.after_delete()` - fires after row delete
+
+All events receive `(row, old_row, logic_row)` parameters and should use `logic_row.log()` for logging.
 
 ## 📁 Key Directories
 

api_logic_server_cli/prototypes/base/database/alembic/alembic_run.py

@@ -0,0 +1,98 @@
+import os
+import subprocess
+import sys
+
+'''
+Pushes the current database/models.py to the database.
+python database/alembic/alembic_run.py [--non-interactive]
+'''
+
+def prompt(msg, non_interactive=False):
+    if non_interactive:
+        print(f"{msg}")
+        print("Running in non-interactive mode...")
+        return
+    try:
+        input(f"{msg}\nPress Enter to continue or Ctrl+C to abort...")
+    except EOFError:
+        print("Running in non-interactive mode (no stdin available)...")
+        return
+
+def run(cmd, env=None):
+    print(f"Running: {cmd}")
+    result = subprocess.run(cmd, shell=True, env=env)
+    if result.returncode != 0:
+        print(f"Command failed: {cmd}")
+        sys.exit(result.returncode)
+
+def main():
+    # Check for non-interactive mode more safely
+    non_interactive = "--non-interactive" in sys.argv
+    if not non_interactive:
+        try:
+            non_interactive = not sys.stdin.isatty()
+        except:
+            # If we can't check stdin, assume non-interactive
+            non_interactive = True
+    
+    orig_dir = os.getcwd()
+    # Change to the database directory (parent of alembic directory) where alembic.ini is located
+    db_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    print(f"Changing directory to {db_dir}")
+    os.chdir(db_dir)
+
+    env = os.environ.copy()
+    env["APILOGICPROJECT_NO_FLASK"] = "True"  # ~ export APILOGICPROJECT_NO_FLASK=True
+
+    print("\n\nThis script will update your database schema to match models.py using Alembic.")
+    print("Steps:")
+    print("1. Set APILOGICPROJECT_NO_FLASK=True -- eg, export APILOGICPROJECT_NO_FLASK=True")
+    print("2. Run: alembic upgrade head")
+    print("3. Run: alembic revision --autogenerate -m \"message\"")
+    prompt("Ready to proceed?", non_interactive)
+
+    run("alembic upgrade head", env=env)
+    print("Database schema updated to latest migration.")
+
+    prompt("Now, a new migration will be generated to match models.py.", non_interactive)
+    if non_interactive:
+        msg = "autogenerated"
+    else:
+        try:
+            msg = input("Enter a message for the migration (default: 'autogenerated'): ") or "autogenerated"
+        except EOFError:
+            msg = "autogenerated"
+    run(f'alembic revision --autogenerate -m "{msg}"', env=env)
+
+    # Find the latest migration file
+    versions_dir = os.path.join(db_dir, "alembic", "versions")
+    migration_files = sorted(
+        [f for f in os.listdir(versions_dir) if f.endswith(".py")],
+        key=lambda x: os.path.getmtime(os.path.join(versions_dir, x)),
+        reverse=True
+    )
+    if migration_files:
+        latest_file = os.path.join(versions_dir, migration_files[0])
+        with open(latest_file, "r") as f:
+            lines = f.readlines()
+        with open(latest_file, "w") as f:
+            for line in lines:
+                f.write(line)
+                if line.strip().startswith("def downgrade"):
+                    f.write("    return\n")
+                    break
+    else:
+        print("No migration file found.")
+        sys.exit(1)
+
+    # Apply the newly generated migration after modifying the migration file
+    prompt(f"Migration file generated: {latest_file}\nIt is recommended to review this migration file before proceeding.", non_interactive)
+    run("alembic upgrade head", env=env)
+
+    print("Migration file updated: downgrade will do nothing.")
+    print("Consider updating ui/admin/admin.yaml to reflect schema changes.")
+    os.chdir(orig_dir)
+    print("\nSuccess! Database schema and migrations are up to date.\n\n")
+
+if __name__ == "__main__":
+    main()

api_logic_server_cli/prototypes/base/database/alembic/readme_alembic.md

@@ -0,0 +1,36 @@
+You can push changes to `database/models.py' to your database automatically, or manually.
+
+<br>
+
+## Automatic
+
+Use:
+
+```bash
+python database/alembic/alembic_run.py [--non-interactive]
+```
+
+<br>
+
+## Manual
+
+The diagram below illustrates a path for enacting changes to the data model, and using [Alembic](https://alembic.sqlalchemy.org/en/latest/index.html) to automate the database changes:
+
+1. Update `database/models.py` (e.g., add columns, tables)
+2. Use alembic to compute the revisions
+```bash
+cd database
+export APILOGICPROJECT_NO_FLASK=True
+alembic revision --autogenerate -m "Added Tables and Columns"
+```
+3. **Edit the revision file** to signify your understanding (see below)
+4. Activate the change
+```bash
+alembic upgrade head 
+unset APILOGICPROJECT_NO_FLASK
+```
+
+![alembic example](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/database/alembic/alembic-overview.png?raw=true)
+
+
+To update your admin app, run `rebuild-from-model`.  For more information, see [Database Design Changes](https://apilogicserver.github.io/Docs/Database-Changes/).

api_logic_server_cli/prototypes/base/docs/training/admin_app_1_context.prompt.md

@@ -1,3 +1,43 @@
 
 Generate a full React Admin application using the following instructions.  
 The result must be a runnable React app (`npm start`) that connects to the supplied JSON:API, with fully implemented components (no placeholders or empty files).
+
+## Critical Data Access Provider Configuration
+
+This project uses a **pre-configured JSON:API data provider** that was built when the project was created. 
+
+### Key Requirements:
+
+1. **Data Provider**: Use the existing `jsonapiClient` from `./rav4-jsonapi-client/ra-jsonapi-client`
+2. **Record Context**: For custom components (like cards), ALWAYS wrap with `<RecordContextProvider value={record}>` 
+3. **List Data Access**: Use `useListContext()` to get data and loading state
+4. **Individual Records**: Use `useRecordContext()` to access record data within providers
+5. **API Root**: The data provider connects to `conf.api_root` (typically `http://localhost:5656/api`)
+
+### Example Pattern for Custom List Views:
+```javascript
+import { useListContext, RecordContextProvider, useRecordContext } from 'react-admin';
+
+const CustomGrid = () => {
+    const { data, isLoading } = useListContext();
+    
+    return (
+        <Grid container>
+            {data?.map(record => (
+                <Grid item key={record.id}>
+                    <RecordContextProvider value={record}>
+                        <CustomCard />
+                    </RecordContextProvider>
+                </Grid>
+            ))}
+        </Grid>
+    );
+};
+
+const CustomCard = () => {
+    const record = useRecordContext();
+    return <Card>{record.name}</Card>;
+};
+```
+
+### CRITICAL: Do NOT create new data providers or modify the existing JSON:API client configuration. The project's data flow depends on the pre-built provider.

api_logic_server_cli/prototypes/base/integration/mcp/mcp_client_executor.py

@@ -21,7 +21,7 @@ See: https://apilogicserver.github.io/Docs/Integration-MCP/
 ################
 
 create_tool_context_from_llm = False
-''' set to False to bypass LLM call and save 2-3 secs in testing, no API Key required. '''
+''' set to False to bypass LLM call and OpenAI API Key requirement. '''
 
 import os, logging, logging.config, sys
 from pathlib import Path
@@ -144,15 +144,15 @@ def query_llm_with_nl(learnings_and_schema: str, nl_query: str):
             temperature=0.2
         )
         tool_context_str = response.choices[0].message.content
-    else:
+    else:  # this is so folks can try mcp without an OpenAI API key
         # read integration/mcp/mcp_tool_context.json
         tool_context_file_path = os.path.join(os.path.dirname(__file__), "../../integration/mcp/examples/mcp_tool_context_response_get.json")
-        if nl_query == default_query_email:
+        if 'email' in nl_query:
             tool_context_file_path = os.path.join(os.path.dirname(__file__), "../../integration/mcp/examples/mcp_tool_context_response.json")
         try:    
             with open(tool_context_file_path, "r") as tool_context_file:
                 tool_context_str = tool_context_file.read()
-                # log.info(f"\n\n2c. Tool context from file {tool_context_file_path}:\n" + tool_context_str)
+                log.info(f"\n\n2c. Tool context from file {tool_context_file_path}:\n" + tool_context_str)
         except FileNotFoundError:
             raise ConstraintException(f"Tool context file not found at {tool_context_file_path}.")
 

api_logic_server_cli/prototypes/base/readme.md

@@ -7,37 +7,35 @@
 - ✅ **JSON:API Endpoints** - REST API for all database tables at `/api/*`
 - ✅ **Swagger Documentation** - Interactive API docs at `/api`
 - ✅ **Business Logic Engine** - Declarative rules in `logic/declare_logic.py`
-- ✅ **Security Framework** - Authentication/authorization in `security/`, using
-```
-als add-auth --provider-type=sql --db-url=
-als add-auth --provider-type=sql --db_url=postgresql://postgres:p@localhost/authdb
-
-als add-auth --provider-type=keycloak --db-url=localhost
-als add-auth --provider-type=keycloak --db-url=hardened
-
-als add-auth --provider-type=None # to disable
-``` 
+- ✅ **Security Framework** - Authentication/authorization in `security/`
 - ✅ **Database Models** - SQLAlchemy ORM in `database/models.py`
 
+See readme files under api, logic and security.
+
 **🚀 Ready to Run:** This is a complete, working system. Just press F5 or run `python api_logic_server_run.py`
 
+<br>
+
 ---
 
 # 🚀 Quick Start
 
-> 🤖 **For GitHub Copilot Users:** See `.github/.copilot-instructions.md` for AI assistant guidance on getting started with this project.
-
 **Bootstrap Copilot by pasting the following into the chat:**
 ```
 Please find and read `.github/.copilot-instructions.md`.
 ```
 
+<br>
+
 **Microservice Automation Complete -- run to verify:** for **VSCode** projects except those downloaded from Web/GenAI:
 1. `Press F5 to Run` (your venv is defaulted)  
 
 &emsp;&emsp;&emsp;&emsp;For **other IDEs,** please follow the [Setup and Run](#1-setup-and-run) procedure, below.
 
-> Tip: create the sample app for customization examples: `ApiLogicServer create --project-name=nw_sample --db_url=nw+`
+<br>
+
+> 💡 **Tip:** Create the sample app for customization examples:  
+> `ApiLogicServer create --project-name=nw_sample --db_url=nw+`
 
 &nbsp;
 

api_logic_server_cli/prototypes/base/security/readme_security.md

@@ -6,7 +6,6 @@ You can add Role Based Access Control (RBAC) to your project, providing:
 Common commands:
 
 ```bash
-```
 als add-auth --provider-type=sql --db-url=
 als add-auth --provider-type=sql --db_url=postgresql://postgres:p@localhost/authdb