ApiLogicServer 15.0.65__py3-none-any.whl → 15.1.0__py3-none-any.whl

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/my-react-app-cards/src/rav4-jsonapi-client/resourceLookup.ts

@@ -0,0 +1,124 @@
+interface Relationship {
+    data: null | { id: string; type: string } | Array<{ id: string; type: string }>;
+    relationships?: { [key: string]: Relationship };
+}
+
+/**
+ * A map-like class that maps resource linkage objects {id: 1, type: "user"} to concrete resources with attributes and
+ * relationships
+ */
+export default class ResourceLookup {
+    lookup: Map<any, any>;
+    includes: string[];
+
+    /**
+     * Constructs a new lookup map
+     * @param {Object} response A JSON API response, in JSON format
+     */
+    constructor(response: any) {
+        this.lookup = new Map();
+        this.includes = [];
+
+        // If the response wasn't a JSON dictionary, we can't and don't need to build a lookup
+        if (typeof response !== 'object') return;
+
+        let resources;
+        // if (response.hasOwnProperty('included')) {
+        if (Object.prototype.hasOwnProperty.call(response, 'included')) {
+            resources = [...response.data, ...response.included];
+        } else {
+            resources = response.data;
+        }
+
+        // Iterate over each resource returned and put each in the lookup
+        for (const entry of resources) {
+            const key = this.getKey(entry);
+            this.lookup.set(key, entry);
+        }
+    }
+
+    /**
+     * Calculates a hashable key for JSON API resources
+     * @param resource A resource linkage object
+     * @returns {string}
+     */
+    getKey(resource: any) {
+        return `${resource.type}:${resource.id}`;
+    }
+
+    /**
+     * Looks up a resource
+     * @param resource A resource linkage object
+     * @returns {Object}
+     */
+    get(resource: any) {
+        // If we don't have included data for this resource, just return the Resource Linkage object, since that's still
+        // useful
+        if (this.has(resource)) {
+            return this.lookup.get(this.getKey(resource));
+        } else {
+            return structuredClone(resource);
+        }
+    }
+
+    /**
+     * Returns true if the resource is in the lookup
+     * @param resource
+     * @returns {boolean}
+     */
+    has(resource: any) {
+        return this.lookup.has(this.getKey(resource));
+    }
+
+    /**
+     * Converts a JSON API data object (with id, type, and attributes fields) into a flattened object
+     * @param {Object} response A JSON API data object
+     */
+    unwrapData(response: any) {
+        // The base resource object, merge the attributes and the id/type fields
+        const result = Object.assign(
+            {
+                id: response?.id,
+                ja_type: response?.type,
+                type: response?.Type || response?.type,
+                attributes: response.attributes || {},
+            },
+            response.attributes
+        );
+
+        // Deal with relationships
+        if (Object.prototype.hasOwnProperty.call(response, 'relationships')) {
+            result.relationships = response.relationships;
+            for (const [relationshipName, relationship] of Object.entries(response.relationships)) {
+                if ((relationship as Relationship).data === null) {
+                    result[relationshipName] = null;
+                }
+
+                if (!(relationship as Relationship).data) {
+                    continue;
+                } else if (Array.isArray((relationship as Relationship).data && (relationship as Relationship).data)) {
+                    result[relationshipName] = (relationship as Relationship).data?.map((linkage: any) => {
+                        const resource = this.get(linkage);
+                        const lresult = structuredClone(this.unwrapData(resource));
+                        Object.entries(lresult.attributes || {}).map(([key, value]) => {
+                            lresult[key] = value;
+                        });
+                        result.relationships[relationshipName].data = result[relationshipName];
+                        return lresult;
+                    });
+                } else if ((relationship as Relationship).data?.id) {
+                    const resource = this.get((relationship as Relationship).data);
+                    result[relationshipName] = this.unwrapData(resource);
+                    result.relationships[relationshipName].data = result[relationshipName];
+                }
+            }
+        }
+
+        try {
+            JSON.stringify(structuredClone(result));
+        } catch (e) {
+            return null;
+        }
+        return structuredClone(result);
+    }
+}

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/my-react-app-cards/src/rav4-jsonapi-client/styles.module.css

@@ -0,0 +1,9 @@
+/* add css module styles here (optional) */
+
+.test {
+  margin: 2em;
+  padding: 0.5em;
+  border: 2px solid #000;
+  font-size: 2em;
+  text-align: center;
+}

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/my-react-app-cards/src/reportWebVitals.js

@@ -0,0 +1,13 @@
+const reportWebVitals = onPerfEntry => {
+  if (onPerfEntry && onPerfEntry instanceof Function) {
+    import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
+      getCLS(onPerfEntry);
+      getFID(onPerfEntry);
+      getFCP(onPerfEntry);
+      getLCP(onPerfEntry);
+      getTTFB(onPerfEntry);
+    });
+  }
+};
+
+export default reportWebVitals;

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/my-react-app-cards/src/setupTests.js

@@ -0,0 +1,5 @@
+// jest-dom adds custom jest matchers for asserting on DOM nodes.
+// allows you to do things like:
+// expect(element).toHaveTextContent(/react/i)
+// learn more: https://github.com/testing-library/jest-dom
+import '@testing-library/jest-dom';

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/templates/bar_chart.jinja

@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Sales by Region</title>
+    <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+    <style>
+        body {
+            margin: 0;
+            padding: 0;
+            display: flex;
+            overflow: hidden;
+            justify-content: center;
+            align-items: center;
+            height: 100%;
+            box-sizing: border-box;
+        }
+        canvas {
+            display: block;
+        }
+    </style>
+</head>
+<body>
+    <canvas id="salesChart" width="200" height="200"></canvas>
+    <script>
+        const labels = [];
+        const data = [];
+        result = {{ result | tojson }};
+        console.log(result);
+        const type = result.chart_type;
+        const title = result.title;
+        const columns = result.columns;
+        console.log(JSON.stringify(result));
+        result.results.forEach(item => {
+            labels.push(item[columns[0]]);
+            data.push(parseFloat(item[columns[1]]));
+        });
+        const ctx = document.getElementById('salesChart').getContext('2d');
+        const salesChart = new Chart(ctx, {
+            type: type,
+            data: {
+                labels: labels,
+                datasets: [{
+                    label: title,
+                    data: data,
+                    backgroundColor: {{ color | tojson }},
+                    borderColor: 'rgba(75, 192, 192, 1)',
+                    borderWidth: 1
+                }]
+            },
+            options: {
+                responsive: true,
+                maintainAspectRatio: false,
+                scales: {
+                    y: {
+                        beginAtZero: true
+                    }
+                }
+            }
+        });
+    </script>
+</body>
+</html>

api_logic_server_cli/prototypes/manager/samples/basic_demo/ui/templates/content.html

@@ -0,0 +1,3 @@
+<pre>
+{{ content }}
+</pre>

api_logic_server_cli/prototypes/manager/samples/basic_demo/venv_setup/py.py

@@ -0,0 +1,121 @@
+#!/usr/bin/env python
+"""
+quick view of python environment
+"""
+
+import os, sys
+import subprocess
+from pathlib import Path
+from sys import platform
+
+__version__ = 5.02
+
+def print_at(label: str, value: str):
+    tab_to = 24 - len(label)
+    spaces = ' ' * tab_to
+    print(f'{label}: {spaces}{value}')
+
+
+def show(cmd: str):
+    try:
+        result_b = subprocess.check_output(cmd, shell=True)
+        result = str(result_b)  # b'pyenv 1.2.21\n'
+        result = result[2: len(result)-3]
+        print_at(cmd, result)
+    except Exception as e:
+        # print(f'Failed: {cmd} - {str(e)}')
+        pass         
+
+
+def python_status():
+    """ print system information and welcome """
+    print(" ")
+    interpreter_path = Path(sys.executable)
+    lib_name = 'Lib' if os.name == "nt" else "lib"  # geesh
+    lib_path = interpreter_path.parent.joinpath(lib_name)
+    lib_str = str(lib_path)
+    # lib_str = "C:\\Users\\val\\dev\\ApiLogicServer\\venv\\Lib"
+    # test_env = "/Users/val/dev/ApiLogicServer/ApiLogicServer-dev/build_and_test/ApiLogicServer/venv/lib"
+    if os.path.exists(lib_str):
+        sys.path.append(lib_str)  # e.g, on Docker -- export PATH=" /home/app_user/api_logic_server_cli"
+
+    try:
+        import api_logic_server_cli.api_logic_server as api_logic_server
+    except Exception as e:
+        api_logic_server = None
+        pass
+    command = "?"
+    if sys.argv[1:]:
+        if sys.argv[1].startswith("welcome"):
+            command = sys.argv[1]
+        elif sys.argv[1] == "sys-info":
+            command = "sys-info"
+        else:
+            print("unknown command - using sys-info")
+            command = "sys-info"
+
+    if command == "sys-info":
+        print("\nEnvironment Variables...")
+        env = os.environ
+        for each_variable in os.environ:
+             print(f'.. {each_variable} = {env[each_variable]}')
+
+        print("\nPYTHONPATH..")
+        for p in sys.path:
+            print(".." + p)
+            
+        print(f'Python Intepreter (sys.executable): {sys.executable}')
+
+        print("")
+        print(f'sys.prefix (venv): {sys.prefix}\n\n')
+
+
+    import socket
+    try:
+        hostname = socket.gethostname()
+        local_ip = socket.gethostbyname(hostname)
+    except:
+        local_ip = f"cannot get local ip from {hostname}"
+        print(f"{local_ip}")
+    try:
+        api_logic_server_version = api_logic_server.__version__
+    except:
+        api_logic_server_version = "*** ApiLogicServer not installed in this environment ***"
+    if command == "sys-info":
+        print_at('ip (gethostbyname)', local_ip)
+        print_at('on hostname', hostname)
+        print_at('python sys.version', sys.version)
+
+    print(f'\nApiLogicServer {api_logic_server_version} -- Press F5 to start server; review readme\n')
+
+    if command.startswith("welcome"):  # don't annoy
+        if command.startswith("welcome-first-time"):
+            tasks_json_path = Path(__file__).parent.parent.joinpath('.vscode/tasks.json')
+            if not os.path.exists(str(tasks_json_path)):
+                print("..warning - unable to update / rename .vscode/tasks.json (file does not exist)")
+            else:
+                use_input = False  # fails even on Mac if Welcome used.  True if platform == "darwin" else False
+                if use_input == False:
+                    pass  # readme explains how to disable start message
+                    # print('..to disable this message, rename .vscode/tasks.json')
+                    # print('..or to keep, alter tasks.json, replacing "welcome-first-time" with "welcome"')
+                else:  # disabled, saved for future reference
+                    everytime = input("Show this next time? (y/n) ")
+                    if everytime == "y":
+                        print("..changing .vscode/tasks.json: replace 'welcome-first-time' with 'welcome'")
+                        data = tasks_json_path.read_text() 
+                        data = data.replace('welcome-first-time', 'welcome') 
+                        tasks_json_path.write_text(data) 
+                    else:
+                        print("..renaming .vscode/tasks.json to .vscode/tasks.json-disabled")
+                        tasks_json_str = str(tasks_json_path)
+                        os.rename(tasks_json_str, tasks_json_str + "-disabled")
+    else:
+        good_bye = f'.. py.py {__version__}'
+        if command != "sys-info":
+            good_bye += ", For more information, use python venv_setup/py.py sys-info"
+        print(good_bye)
+    print("")
+ 
+if __name__ == '__main__':
+    python_status()

api_logic_server_cli/prototypes/manager/samples/basic_demo/venv_setup/readme_venv.md

@@ -0,0 +1,20 @@
+# API Logic Project - `venv` Setup 
+
+Once you use `ApiLogicServer` to create your project, you need to create the `venv` Python environment (unless you are using the Docker version of API Logic Server).
+
+## Create the `venv'
+
+Proceed as described in the [API Logic Server Readme](https://github.com/valhuber/ApiLogicServer/blob/main/README.md#installation).  This contains the latest information.
+
+You may find the command line scripts in this folder helpful to save typing.  
+  
+  * The `.ps1` version is for Windows PowerShell
+  * The `-linux` version has been tested for Ubuntu, and
+  * The `venv.sh` has been tested on the Mac.
+
+## Verify the `venv'
+
+Optionally, you can check your Python environment by running:
+```
+Python py.py
+```

api_logic_server_cli/prototypes/manager/samples/basic_demo/venv_setup/requirements-no-cli.txt

@@ -0,0 +1,33 @@
+PyJWT==2.6.0
+python-dateutil==2.8.2
+six==1.16.0
+SQLAlchemy>=2.0.0
+Flask-SQLAlchemy>=3.0.0
+SQLAlchemy-Utils>=0.38.2
+Werkzeug==2.2.3
+logicbankutils==0.6.0
+inflect==5.0.2
+itsdangerous==2.1.2
+Jinja2==3.1.2
+MarkupSafe==2.1.1
+safrs>=3.0
+Flask-Admin==1.5.7
+flask-cors==3.0.0
+flask==2.2.2
+Flask-JWT-Extended==4.4.4
+Flask-Login==0.6.2
+Flask-OpenID==1.3.0
+python-dotenv==0.15.0
+email-validator==1.1.1
+LogicBank==1.08.02
+PyMySQL==1.0.2
+# pyodbc==4.0.32
+cryptography==36.0.1
+requests==2.27.1
+gunicorn==20.1.0
+psycopg2-binary>=2.9.5; python_version < '3.13'
+psycopg[binary]>=3.1.0; python_version >= '3.13'
+DotMap==1.3.25
+WTForms==2.3.3
+behave==1.2.6
+alembic==1.7.7

api_logic_server_cli/prototypes/manager/samples/basic_demo/venv_setup/venv-linux.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+if [ $# -eq 0 ]
+    then
+        echo " "
+        echo "Installs virtual environment (as venv)"
+        echo " "
+        echo " IMPORTANT - Linux only, not required for docker-based projects"
+        echo " .. Windows: https://apilogicserver.github.io/Docs/Project-Env/"
+        echo " "
+        echo "Usage:"
+        echo "  cd ApiLogicProject     # your project directory"
+        echo "  sh venv_setup/venv.sh go      # for python3, or..."
+        echo "  sh venv_setup/venv.sh python  # for python"
+        echo " "
+        exit 0
+    fi
+
+if [ "$1" = "python" ]
+    then
+        python -m venv venv
+        . venv/bin/activate  # Mac uses  uses source venv/bin/activate
+        python -m pip install -r requirements.txt
+    else
+        python3 -m venv venv
+        . venv/bin/activate  # Mac uses  uses source venv/bin/activate
+        python3 -m pip install -r requirements.txt
+fi

api_logic_server_cli/prototypes/manager/samples/basic_demo/venv_setup/venv.ps1

@@ -0,0 +1,21 @@
+if($args.Count -eq 0) {
+
+        Write-Output " "
+        Write-Output "Installs virtual environment (as venv)"
+        Write-Output " "
+        Write-Output " IMPORTANT - Windows only, not required for docker-based projects"
+        Write-Output " "
+        Write-Output "Usage:"
+        Write-Output "  cd ApiLogicProject  # your project directory"
+        Write-Output "  .\venv_setup\venv.ps1 go"
+        Write-Output " "
+        exit 0
+}
+
+# virtualenv venv
+# venv\Scripts\activate
+# pip install -r requirements.txt  # may require that you update pip version, as recommended
+
+python -m venv venv
+venv\Scripts\activate
+python -m pip install -r requirements.txt  # works for recent Python >= 3.9

api_logic_server_cli/prototypes/manager/samples/basic_demo/venv_setup/venv.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+if [ $# -eq 0 ]
+    then
+        echo " "
+        echo "Installs virtual environment (as venv)"
+        echo " "
+        echo " IMPORTANT - Mac only, not required for docker-based projects"
+        echo " .. Windows: https://apilogicserver.github.io/Docs/Project-Env/"
+        echo " "
+        echo "Usage:"
+        echo "  cd ApiLogicProject     # your project directory"
+        echo "  sh bin/venv.sh go      # for python3, or..."
+        echo "  sh bin/venv.sh python  # for python"
+        echo " "
+        exit 0
+    fi
+
+if [ "$1" = "python" ]
+    then
+        python -m venv venv
+        source venv/bin/activate   # ubuntu/linux uses . venv/bin/activate
+        python -m pip install -r requirements.txt
+    else
+        python3 -m venv venv
+        source venv/bin/activate   # ubuntu/linux uses . venv/bin/activate 
+        python3 -m pip install -r requirements.txt
+fi

api_logic_server_cli/prototypes/manager/samples/dbs/readme_dbs.md

@@ -1,11 +1,11 @@
 See https://apilogicserver.github.io/Docs/Data-Model-Examples/
 
-These files are symbolic links to pre-installed sqlite databases.  These allow you to explore creating projects from existing databases.
+These are pre-installed sqlite databases.  These allow you to explore creating projects from existing databases.
 
-For example, create Northwind like this:
+For example, create Northwind and basic_demo like this:
 
 ```bash
 genai-logic create  --project_name=nw --db_url=sqlite:///samples/dbs/nw.sqlite
-```
 
-> Note: If the symbolic links are missing, it is probably due to permission issues, e.g., on windows you must run the Shell with Admin privileges.  You can continue using the abbeviations instead of a standard SQLAlchemy database uri.
+genai-logic create --project_name=basic_demo --db_url=sqlite:///samples/dbs/basic_demo.sqlite
+```

api_logic_server_cli/prototypes/manager/samples/readme_samples.md

@@ -1,8 +1,14 @@
 ## Pre-built samples
 
-See https://apilogicserver.github.io/Docs/Data-Model-Examples/
+See https://apilogicserver.github.io/Docs/Data-Model-Examples/.  The Manager contains the following pre-built samples:
 
-The created `samples/nw_sample` illustrates important customization sample code - a key part of training.  Search for #als.
+* `samples/nw_sample` illustrates important customization sample code - a key part of training.  **Search for #als to find customization samples.**
+
+* `samples/nw_sample_nocust` is the same database, but without customizations.  With no customizations, the default nw example illustrates the **level of automation you should expect for your own projects.**
+
+* `samples/basic_demo` is the pre-built demo tutorial.  You can r**ebuild it using the readme's.**
+
+<br>
 
 ## Sqlite Sample Databases
 
@@ -15,6 +21,7 @@ genai-logic create  --project_name=nw --db_url=sqlite:///samples/dbs/nw.sqlite
 
 genai-logic create --project_name=basic_demo --db_url=sqlite:///samples/dbs/basic_demo.sqlite
 ```
+<br>
 
 ## Database Connectivity
 
@@ -30,7 +37,7 @@ genai-logic create --db_url=sqlite:////Users/val/dev/ApiLogicServer/ApiLogicServ
 genai-logic create --db_url=mysql+pymysql://root:p@localhost:3306/classicmodels --project_name=docker_classicmodels
 genai-logic create --db_url=mysql+pymysql://root:p@localhost:3306/Chinook --project_name=docker_chinook
 
-# from container to mysql container  replace localhost with....
+# from container to mysql container -- replace localhost with container name...
 genai-logic create --db_url=mysql+pymysql://root:p@mysql-container:3306/Chinook --project_name=/localhost/docker_chinook
 
 # microsoft sql server (setup: https://apilogicserver.github.io/Docs/Install-pyodbc/)
@@ -51,9 +58,11 @@ genai-logic create --project_name=Chinook \
   --db_url=mysql+pymysql://ApiLogicServer:@ApiLogicServer.mysql.pythonanywhere-services.com/ApiLogicServer\$Chinook
 ```
 
+<br>
+
 ## Docker Databases
 
-You probably don't need _all_ these, but here's how you start the docker databases (schema details below):
+You probably don't need _all_ these, but here's how you start the docker databases:
 
 ```
 docker network create dev-network  # only required once
@@ -66,5 +75,3 @@ docker run --name sqlsvr-container --net dev-network -p 1433:1433 -d apilogicser
 
 docker run --name sqlsvr-container --net dev-network -p 1433:1433 -d apilogicserver/sqlsvr-m1:latest  # Mac M1
 ```
-
-

api_logic_server_cli/prototypes/manager/system/Manager_workspace.code-workspace

@@ -9,7 +9,8 @@
 		"workbench.editorAssociations": {
 			"*.md": "vscode.markdown.preview.editor"
 		},
-		"workbench.colorTheme": "Word (Light)",
-		"workbench.preferredLightColorTheme": "Word (Light)"
+    	"debug.console.wordWrap": false,
+		"workbench.colorTheme": "Arduino Light",
+		"workbench.preferredLightColorTheme": "Arduino Light"
 	}
 }

{apilogicserver-15.0.65.dist-info → apilogicserver-15.1.0.dist-info}/METADATA

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