ApiLogicServer 14.3.25__py3-none-any.whl → 14.4.0__py3-none-any.whl

api_logic_server_cli/prototypes/manager/system/genai/graphics_templates/{graphics_services.py → graphics_services_api_xxx.py}

@@ -29,13 +29,4 @@ app_logger = logging.getLogger("api_logic_server_app")
 def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_decorators = []):
     pass
 
-    api.expose_object(GraphicsServices)  # Swagger-visible services
 
-
-"""
-Illustrates #als: apis for graphics
-
-* Custom service - visible in swagger
-"""
-class GraphicsServices(safrs.JABase):
-    pass

api_logic_server_cli/prototypes/manager/system/genai/graphics_templates/graphics_services_db.jinja

@@ -0,0 +1,46 @@
+from database import models
+import logging
+from safrs import jsonapi_attr
+from sqlalchemy.orm import relationship, remote, foreign
+from functools import wraps # This convenience func preserves name and docstring
+import decimal as decimal
+from sqlalchemy import extract, func
+from flask import request, jsonify
+from safrs import jsonapi_rpc, SAFRSAPI
+import safrs
+
+"""
+Graphics methods for database classes, created when: 
+* `als genai create` contains prompts like: 'Graph Sales by Category', etc.
+* `als add-graphics` --using the docs/graphics directory
+
+Called by api/api_discovery/dashboard_services.py when admin app loaded
+
+You typically do not alter this file - rebuilt on als genai--graphics.
+
+"""
+
+app_logger = logging.getLogger(__name__)
+
+
+def add_method(cls):
+  """
+  Decorator to add method to class, e.g., db class group by query method
+
+  Thanks to: https://mgarod.medium.com/dynamically-add-a-method-to-a-class-in-python-c49204b85bd6
+  """
+  def decorator(func):
+    @wraps(func) 
+    def wrapper(self, *args, **kwargs): 
+      return func(*args, **kwargs)
+    
+    setattr(cls, func.__name__, wrapper)
+    # Note we are not binding func, but wrapper which accepts self but does exactly the same as func
+    return func # returning func means func can still be used normally
+  return decorator
+
+##############################
+# generated services follow
+##############################
+
+

api_logic_server_cli/prototypes/manager/system/genai/graphics_templates/graphics_services_db_each_method.jinja

@@ -0,0 +1,36 @@
+
+@classmethod
+@add_method(models.{{class_x_axis}})
+@jsonapi_rpc(http_methods=['GET', 'OPTIONS'])
+def {{name}}(*args, **kwargs):
+    """        
+    Complex query with multiple joins, for graphics, from 'Graph Sales by Category', etc.
+    Test with Swagger.
+    """
+    if request.method == 'OPTIONS':
+        return jsonify({ "result": "ok" })
+        
+    from database.models import {{classes_used}}
+    db = safrs.DB
+    session = db.session    # sqlalchemy.orm.scoping.scoped_session
+    # Security.set_user_sa()  # an endpoint that requires no auth header (see also @bypass_security)
+
+    # SQLAlchemy query
+    query = {{ sqlalchemy_query }} 
+    # Execute query and fetch results
+    results = query.all()
+    from decimal import Decimal
+    columns = ['{{ xAxis }}' , '{{ yAxis }}']
+    results = [{columns[0]: row[0], columns[1]: round(float(row[1]), 2)} for row in results]
+    title = '{{ title }}'
+    graph_type = '{{ graph_type }}'.lower()
+    json_results = {
+        "results": results,
+        "columns": columns,
+        "title": title,
+        "chart_type": graph_type,
+        "xAxis": columns[0],
+        "yAxis": columns[1],
+    }
+    
+    return json_results 

api_logic_server_cli/prototypes/manager/system/genai/prompt_inserts/graphics.prompt

@@ -1,8 +1,11 @@
 
-Create WGResult Graphics for prompts like 'graph sales by region'.
-    * use 'sales by region' to create a WGResult Graphic.sqlalchemy_query
+Create WGResult Graphics, with graphics elements for each prompts like 'graph sales by region'.
+    * do not create graphics elements unless explicitly requested.
+    * query results should always return exactly 2 columns.
+    * use 'sales by region' to create a WGResult Graphic.sqlalchemy_query for *each* such line
     * Be sure to use class names, not table names
-    * for example, using Northwind:
+    * Create joins for only explicitly defined foreign key relationships
+    * for example, using Northwind - important!  note the 2 right parens closing label("Total Sales"):
         # SQLAlchemy query for Sales by Category
         sales_by_category = (
             session.query(
@@ -16,3 +19,4 @@ Create WGResult Graphics for prompts like 'graph sales by region'.
             .group_by(Category.CategoryName)
             .order_by(func.sum(OrderDetail.Quantity * OrderDetail.UnitPrice * (1 - OrderDetail.Discount)).desc())
         )
+

api_logic_server_cli/prototypes/manager/system/genai/prompt_inserts/response_format.prompt

@@ -21,7 +21,14 @@ class Graphic(BaseModel):
     sqlalchemy_query: str  # sqlalchemy query using group by, returns result = { "result": [ ("name", "value")  ] }
     sql_query: str  # sql query using group by, returns result = { "result": [ ("name", "value")  ] }
     classes_used: str # comma-delimited list of classes used in sqlalchemy_query
-    name: str  # suggested Python name for sqlalchemy_query
+    class_x_axis: str # name of class for x axis
+    name: str  # suggested Python name for sqlalchemy_query - unique
+    prompt: str  # prompt used to create the graphic
+    title: str # expanded name
+    xAxis: str # caption for x axis
+    yAxis: str # caption for y axis
+    dashboard: bool  # whether appears on home page
+    graph_type: str  # Bar, Line, Pie
     html_code: str # create a java script app to show a bar chart from sqlalchemy_query result
 
 class WGResult(BaseModel):  # must match system/genai/prompt_inserts/response_format.prompt

api_logic_server_cli/prototypes/manager/system/install-ApiLogicServer-dev/install-ApiLogicServer-dev.ps1

@@ -0,0 +1,100 @@
+
+param(
+    [Parameter()]
+    [String]$IDE
+)
+
+SRA="venv/lib/python3.12/site-packages/api_logic_server_cli/create_from_model/safrs-react-admin-npm-build"
+
+if (Test-Path -Path $SRA) {
+    Write-Output " "
+    Write-Output "(SRA location verified)"
+    Write-Output " "
+} else {
+    Write-Output " "
+    Write-Output "Safrs React Admin (SRA) not found - please fix line above"
+    Write-Output " "
+    Exit 1
+}
+
+$clonedocs = $true
+Write-Output "IDE specified as: $IDE"
+
+if($IDE -eq "") {
+    Write-Output " "
+    Write-Output "Installs dev version of ApiLogicServer and safrs-react-admin (version 7.0.15)"
+    Write-Output "   .. vscode option creates venv, and starts vscode on workspace "
+    Write-Output "   .. See: https://apilogicserver.github.io/Docs/Architecture-Internals"
+    Write-Output " "
+    Write-Output " IMPORTANT - create a folder, then install:"
+    Write-Output "   > mkdir ApiLogicServer"
+    Write-Output " "
+    Write-Output "   > .\Install-ApiLogicServer-Dev [ vscode | charm | x ]"
+    Write-Output " "
+    Exit
+}
+ls
+Write-Output " "
+$Ready= Read-Host -Prompt "Verify ApiLogicServer-dev does not exist, and [Enter] install *dev* version of ApiLogicServer for $1> "
+Set-PSDebug -Trace 0
+
+if (Test-Path -Path "ApiLogicServer-dev") {
+    Write-Output " "
+    Write-Output "Really, ApiLogicServer-dev must not exist"
+    Write-Output " "
+    Exit 1
+}
+
+mkdir ApiLogicServer-dev
+cd ApiLogicServer-dev
+mkdir servers    # good place to create ApiLogicProjects
+mkdir build_and_test
+mkdir org_git  # git clones from org ApiLogicServer here
+cd org_git
+
+if ($clonedocs -eq $true) {
+    Write-Output "\n Docs setup (slow) "
+    git clone https://github.com/ApiLogicServer/Docs.git
+    cd Docs
+    python -m venv venv
+    venv\Scripts\activate
+    pip -m install -r requirements.txt
+    cd ..
+} else {
+    Write-Output "\n Docs setup DECLINED "
+}
+
+
+git clone https://github.com/ApiLogicServer/ApiLogicServer-src.git
+cd ApiLogicServer-src
+ls
+# $Ready= Read-Host -Prompt "Should be at -src - ready to copy sra build $1> "
+cp -r ../../../$SRA api_logic_server_cli/create_from_model/safrs-react-admin-npm-build
+
+
+if ($IDE -eq "vscode") {
+    python -m venv venv
+    # pwd
+    # ls
+    venv\Scripts\activate
+    python -m pip install -r requirements.txt
+    code .vscode/ApiLogicServerDev.code-workspace
+    Set-PSDebug -Trace 0
+    Write-Output ""
+    Write-Output "Workspace opened; use pre-created Launch Configurations:"
+    Write-Output "  * Run 1 - Create ApiLogicProject, then..."
+    Write-Output "  * Run 2 - RUN ApiLogicProject"
+} elseif ($IDE -eq "pycharm") {
+    charm .
+    Set-PSDebug -Trace 0
+    Write-Output "  * Python Interpreter > Add New Environment (default, to create venv)"
+    Write-Output "     IMPORTANT - NOT DOCKER"
+    Write-Output "  * then open requirements.txt - PyCharm should **Install Requirements**"
+    Write-Output "     If this fails, use a terminal to run pip install -r requirements.txt"
+} else {
+    Write-Output "No IDE started"
+}
+Write-Output ""
+Write-Output "IDEs are preconfigured with run/launch commands to create and run the sample"
+Write-Output ""
+exit 0

api_logic_server_cli/prototypes/manager/system/install-ApiLogicServer-dev/install-ApiLogicServer-dev.sh

@@ -0,0 +1,116 @@
+#!/bin/bash
+
+contains()
+  # echo contains check $1 in $2
+  case "$1" in
+    (*"$2"*) true;;
+    (*) false;;
+  esac
+
+sra="venv/lib/python3.12/site-packages/api_logic_server_cli/create_from_model/safrs-react-admin-npm-build"
+if [ -d $src ] 
+then
+    echo "\n(SRA location verified)\n" 
+else
+    echo "\n(SRA location not found)\n" 
+    echo "Please fix variable above"
+    exit 1
+fi
+
+sra_curl="0.2.9/$sra"
+
+ostype=$(uname -a)
+if contains "Ubuntu" $ostype; then
+  ostype="ubuntu"
+fi
+# if contains "ubuntu" $ostype; then
+#   echo $ostype contains ubuntu
+# fi
+
+# normally true, use false for skipping long clone during testing 
+clonedocs=true
+
+if [ $# -eq 0 ]
+  then
+    echo " "
+    # echo "shell: $SHELL"
+    echo "Installs dev version of ApiLogicServer and safrs-react-admin on $ostype (version 7.0.15)\n"
+    echo "   .. vscode option creates venv, and starts vscode on workspace"
+    echo "  .. See: https://apilogicserver.github.io/Docs/Architecture-Internals"
+    echo " "
+    echo "   > sh system/install-ApiLogicServer-dev/install-ApiLogicServer-dev.sh [ vscode | charm | x ]"
+    echo " "
+    exit 0
+  else
+    ls
+    echo " "
+    read -p "Verify ApiLogicServer-dev does not exist, and [Enter] install *dev* version of ApiLogicServer for $1> "
+    if [ -d "ApiLogicServer-dev" ] 
+    then
+        echo "\nReally, ApiLogicServer-dev must not exist\n" 
+        exit 1
+    fi
+    set -x
+    mkdir ApiLogicServer-dev
+    cd ApiLogicServer-dev
+    mkdir servers    # good place to create ApiLogicProjects
+    mkdir build_and_test
+    mkdir org_git  # git clones from org ApiLogicServer here
+    cd org_git
+
+    if [ "$clonedocs" = true ]
+      then
+        git clone https://github.com/ApiLogicServer/Docs
+        cd Docs
+        python3 -m venv venv       # may require python -m venv venv
+        if contains "ubuntu" $ostype; then
+          echo $ostype contains ubuntu
+          . venv/bin/activate
+        else
+          echo $ostype does not contain ubuntu
+          source venv/bin/activate   # windows venv\Scripts\activate
+        fi
+        pip install -r requirements.txt
+        cd ..
+    fi
+    
+    git clone https://github.com/ApiLogicServer/ApiLogicServer-src.git
+    cd ApiLogicServer-src
+    echo "\ncopying $sra --> ApiLogicServer"
+    cp -r ../../../$sra api_logic_server_cli/create_from_model/safrs-react-admin-npm-build
+    
+    #
+    #
+    # read -p "Installed - ready to launch IDE..."
+    if [ "$1" = "vscode" ]
+      then
+        python3 -m venv venv       # may require python -m venv venv
+        # pwd
+        # ls
+        . venv/bin/activate
+        # read -p "venv created; do optional pre-installs now $1> "
+        python3 -m pip install -r requirements.txt    # you may need to use pip3, or restart your terminal session
+        code .vscode/ApiLogicServerDev.code-workspace
+        set +x
+        echo ""
+        echo "Workspace opened; use pre-created Launch Configurations:"
+        echo "  * Run 1 - Create ApiLogicProject, then..."
+        echo "  * Run 2 - RUN ApiLogicProject"
+    elif [ "$1" = "charm" ]
+    then
+        charm .
+        set +x
+        echo "  * Python Interpreter > Add New Environment (default, to create venv)"
+        echo "     IMPORTANT - NOT DOCKER"
+        echo "  * then open requirements.txt - PyCharm should **Install Requirements**"
+        echo "     If this fails, use a terminal to run pip install -r requirements.txt"
+    else
+      set +x
+    fi
+    echo ""
+    echo "IDEs are preconfigured with run/launch commands to create and run the sample"
+    echo ""
+    echo "ApiLogicServer/react-admin contains shell burn-and-rebuild-react-admin"
+    echo ""
+    exit 0
+fi

api_logic_server_cli/prototypes/manager/system/install-ApiLogicServer-dev/readme.md

@@ -0,0 +1,7 @@
+To install the source code of API Logic Server:
+
+```bash
+sh system/install-ApiLogicServer-dev/install-ApiLogicServer-dev.sh [ vscode | charm | x ]
+```
+
+> This is ***not*** required to use API Logic Server.

api_logic_server_cli/prototypes/manager/system/style-guide.yaml

@@ -12,7 +12,7 @@ date_format: 'LL'
 edit_on_mode : 'dblclick' 
 min_decimal_digits: '2'
 max_decimal_digits: '4' 
-decimal_min: '0'
+decimal_min: '2'
 decimal_max: '1000000000'
 row_height: small,
 include_translation: 'false'
@@ -20,7 +20,7 @@ use_keycloak: 'false'
 keycloak_url: http://localhost:8080
 keycloak_realm: kcals
 keycloak_client_id: alsclient
-serviceType: OntimizeEE
+serviceType: JSONAPI
 locale: en
 applicationLocales: ["en","es"]
 startSessionPath: /auth/login

api_logic_server_cli/prototypes/manager/webgenai/README.md

@@ -0,0 +1,6 @@
+Default location for WebGenAI - projects, sqlite databases, etc.
+* Examine these to verify genai logic, but use export to debug or make changes.
+* See [Export](https://apilogicserver.github.io/Docs/WebGenAI-CLI/#export)
+* See [Import / Merge WebGenai](https://apilogicserver.github.io/Docs/IDE-Import-WebGenAI/)
+
+See docker_compose for WebGenAI run instructions.

api_logic_server_cli/prototypes/nw/docs/graphics/count_orders_by_category.prompt

@@ -0,0 +1 @@
+Graph number of sales per category, for dashboard

api_logic_server_cli/prototypes/nw/docs/graphics/order_count_by_month.prompt

@@ -0,0 +1 @@
+Graph count orders by month