ApiLogicServer 14.3.14__py3-none-any.whl → 14.3.20__py3-none-any.whl

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo_docs_logic/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/system/genai/examples/genai_demo/genai_demo_docs_logic/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/system/genai/examples/genai_demo/genai_demo_docs_logic/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/system/genai/learning_requests/logic_bank_api.prompt

@@ -10,7 +10,7 @@ Use only the methods provided below.
 
 
 class Rule:
-    """Invoke these functions to declare rules in the created declare_logic function.  """
+    """ Invoke these functions to declare rules """
 
     @staticmethod
     def sum(derive: Column, as_sum_of: any, where: any = None, insert_parent: bool=False):
@@ -149,50 +149,40 @@ class Rule:
 
 Expanded example:
 
-Prompt:
-
-    Use Logic Bank to enforce the Check Credit requirement (do not generate check constraints):
+    Prompt:
         1. Customer.balance <= credit_limit
         2. Customer.balance = Sum(Order.amount_total where date_shipped is null)
         3. Order.amount_total = Sum(Item.amount)
         4. Item.amount = quantity * unit_price
         5. Store the Item.unit_price as a copy from Product.unit_price
 
-Response:
-
-def declare_logic():  # created by Web/GenAI for ApiLogicServer, LogicBank
-    
-    Rule.sum(derive=CustomerAccount.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)
-    Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)
-    Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)
-    Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)
-    Rule.constraint(validate=CustomerAccount,
-                    as_condition=lambda row: row.balance <= row.credit_limit,
-                    error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
+    Response:
+        Rule.sum(derive=CustomerAccount.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)
+        Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)
+        Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)
+        Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)
+        Rule.constraint(validate=CustomerAccount,
+                        as_condition=lambda row: row.balance <= row.credit_limit,
+                        error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
 
 
 Equivalent expanded example using informal syntax:
 
-Prompt:
-
-    Use Logic Bank to enforce the Check Credit requirement (do not generate check constraints):
+    Prompt:
         1. The Customer's balance is less than the credit limit
         2. The Customer's balance is the sum of the Order amount_total where date_shipped is null
         3. The Order's amount_total is the sum of the Item amount
         4. The Item amount is the quantity * unit_price
         5. The Item unit_price is copied from the Product unit_price
 
-Response is the same:
-
-def declare_logic():  # created by Web/GenAI for ApiLogicServer, LogicBank
-    
-    Rule.sum(derive=CustomerAccount.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)
-    Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)
-    Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)
-    Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)
-    Rule.constraint(validate=CustomerAccount,
-                    as_condition=lambda row: row.balance <= row.credit_limit,
-                    error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
+    Response is the same:
+        Rule.sum(derive=CustomerAccount.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)
+        Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)
+        Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)
+        Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)
+        Rule.constraint(validate=CustomerAccount,
+                        as_condition=lambda row: row.balance <= row.credit_limit,
+                        error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
 
 
 Intermediate sum/count values require a new column, with a LogicBank sum/count rule.  For example:
@@ -246,19 +236,6 @@ Response is to create 2 rules - a count derivation and a constraint, as follows:
                     as_condition=lambda row: row.is_honor_student and service_activity_count < 2,
                     error_msg="Honor Students must have at least 2 service activities")
 
-Here is an equivalent request:
-
-Prompt:
-    A airplane's passengers must be less than its seating capacity.
-
-Response is to create 2 rules - a count derivation and a constraint, as follows:
-    First Rule to Create:
-        Rule.count(derive=Airplane.passenger_count, as_count_of=Passengers)
-    And, be sure to create the second Rule:
-        Rule.constraint(validate=Airplane,
-                    as_condition=lambda row: row.passenger_count <= row.seating_capacity,
-                    error_msg="Airplane value total ({row.passenger_count}) exceeds limit ({row.seating_capacity})")
-
 
 For "more than" constraints, create columns with count rules:
 

api_logic_server_cli/prototypes/manager/webgenai/docker-compose-webg.yml

@@ -0,0 +1,33 @@
+# Run WebGenAI locally from docker container
+
+# Before running, update ./system/genai/webg_local/webg_config/web_genai.txt
+# See: https://apilogicserver.github.io/Docs/WebGenAI-CLI/#configuration
+
+# cd <manager>  
+
+# docker compose -f webgenai/docker-compose-webg.yml up
+# docker compose -f webgenai/docker-compose-webg.yml down
+
+# if you have run docker compose up (above), you must run docker compose down to run directly:
+
+# docker run -it --rm --name webgenai -p 8282:80  --env-file ./webgenai/webg_config/web_genai.txt -v ./webgenai/webg_temp:/tmp  -v ./webgenai/webg_config:/config -v ./webgenai/webg_projects:/opt/projects apilogicserver/web_genai
+
+name: webgenie
+services:
+    web_genai:
+        stdin_open: true
+        tty: true
+        container_name: webgenai
+        ports:
+            - 8282:80
+        env_file:
+            - ./webg_config/web_genai.txt
+        volumes:
+            - ./webg_temp:/tmp
+            - ./webg_config:/config
+            - ./webg_projects:/opt/projects
+        image: apilogicserver/web_genai 
+        user: root
+        environment:
+            - GENAI_LOGIC_APIKEY=<paste license here from registration email>
+            - APILOGICSERVER_CHATGPT_APIKEY=<sk-proj-your-openai-key-here>    

api_logic_server_cli/prototypes/manager/webgenai/webg_config/license.json

@@ -0,0 +1,6 @@
+{
+    "license_key": "ABCD-1234-EFGH-5678",
+    "license_type": "PRO",
+    "expiry": "2025-12-31",
+    "signature": "ExPd5FL9VI6jOpDruwgBUF3knikbD9xAxNgq0Yneah0="
+}

api_logic_server_cli/prototypes/manager/webgenai/webg_config/web_genai.txt

@@ -0,0 +1,13 @@
+# App configuration
+APILOGICPROJECT_EXTERNAL_PORT=8282
+APILOGICPROJECT_PORT=5657
+APILOGICSERVER_CHATGPT_APIKEY=sk-proj-< your api key >
+#GENAI_LOGIC_APIKEY=your_api_key_from_registration_email
+
+# WebGenAI security configuration
+# login password for the admin user
+# ADMIN_PASSWORD=password
+
+# WebGenAI GitHub configuration
+GH_TOKEN={personal access token from github}
+GH_ORG=github.com/<gh-user-name>

api_logic_server_cli/prototypes/nw/api/api_discovery/sales_by_category.py

@@ -0,0 +1,50 @@
+from flask import request, jsonify
+import logging
+import safrs
+from sqlalchemy.orm import aliased
+from sqlalchemy import func
+from database.models import Category, Product, OrderDetail, Order
+
+app_logger = logging.getLogger("api_logic_server_app")
+
+def add_service(app, api, project_dir, swagger_host: str, PORT: str, method_decorators = []):
+    pass
+
+    @app.route('/sales_by_category')
+    def sales_by_category():
+        """        
+        Illustrates:
+        * Complex query with multiple joins
+
+        Test it with:
+        
+                curl -X GET "http://localhost:5656/sales_by_category"
+        
+        """
+        db = safrs.DB           # Use the safrs.DB, not db!
+        session = db.session    # sqlalchemy.orm.scoping.scoped_session
+        # Security.set_user_sa()  # an endpoint that requires no auth header (see also @bypass_security)
+
+        # Alias tables for better readability
+        category = aliased(Category)
+        product = aliased(Product)
+        order_detail = aliased(OrderDetail)
+        order = aliased(Order)
+
+        # SQLAlchemy query for Sales by Category
+        sales_by_category = (
+            session.query(
+                category.CategoryName,
+                func.sum(order_detail.Quantity * order_detail.UnitPrice * (1 - order_detail.Discount)).label("TotalSales")
+            )
+            .join(product, category.Id == product.CategoryId)
+            .join(order_detail, product.Id == order_detail.ProductId)
+            .join(order, order_detail.OrderId == order.Id)
+            .filter(order.ShippedDate.isnot(None))  # Consider only shipped orders
+            .group_by(category.CategoryName)
+            .order_by(func.sum(order_detail.Quantity * order_detail.UnitPrice * (1 - order_detail.Discount)).desc())
+        )
+
+        # Execute query and fetch results
+        results = sales_by_category.all()
+        return jsonify( { "result": results } )

api_logic_server_cli/prototypes/nw/api/api_discovery/sales_by_category_bar_chart.html

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Bar Chart Example</title>
+    <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
+</head>
+<body>
+    <canvas id="myChart" width="400" height="200"></canvas>
+    <script>
+        // Input data
+        const result = {
+            "result": [
+                "('Beverages', Decimal('262288.9800000000'))",
+                "('Dairy Products', Decimal('230535.1650000000'))",
+                "('Confections', Decimal('164672.0520000000'))",
+                "('Meat/Poultry', Decimal('162132.2095000000'))",
+                "('Seafood', Decimal('129548.6375000000'))",
+                "('Condiments', Decimal('105047.1850000000'))",
+                "('Produce', Decimal('93117.7975000000'))",
+                "('Grains/Cereals', Decimal('90779.5825000000'))"
+            ]
+        };
+
+        // Parse the input data
+        const labels = [];
+        const data = [];
+        result.result.forEach(item => {
+            const match = item.match(/\('(.+)', Decimal\('([\d.]+)'\)\)/);
+            if (match) {
+                labels.push(match[1]);
+                data.push(parseFloat(match[2]));
+            }
+        });
+
+        // Create the bar chart
+        const ctx = document.getElementById('myChart').getContext('2d');
+        const myChart = new Chart(ctx, {
+            type: 'bar',
+            data: {
+                labels: labels,
+                datasets: [{
+                    label: 'Sales',
+                    data: data,
+                    backgroundColor: 'rgba(75, 192, 192, 0.2)',
+                    borderColor: 'rgba(75, 192, 192, 1)',
+                    borderWidth: 1
+                }]
+            },
+            options: {
+                scales: {
+                    y: {
+                        beginAtZero: true
+                    }
+                }
+            }
+        });
+    </script>
+</body>
+</html>

api_logic_server_cli/prototypes/nw/api/api_discovery/sales_by_category_bar_chart_app.request

@@ -0,0 +1 @@
+create a java script app to show a bar chart from this input: result = { "result": [ "('Beverages', Decimal('262288.9800000000'))", "('Dairy Products', Decimal('230535.1650000000'))", "('Confections', Decimal('164672.0520000000'))", "('Meat/Poultry', Decimal('162132.2095000000'))", "('Seafood', Decimal('129548.6375000000'))", "('Condiments', Decimal('105047.1850000000'))", "('Produce', Decimal('93117.7975000000'))", "('Grains/Cereals', Decimal('90779.5825000000'))" ] }

api_logic_server_cli/prototypes/nw/api/api_discovery/sales_by_category_bar_chart_query.request

@@ -0,0 +1,3 @@
+Northwind Sales by Category as a SQLAlchemy qry
+
+-- see api/api_discovery/sales_by_category.py

apilogicserver-14.3.20.dist-info/METADATA

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: ApiLogicServer
+Version: 14.3.20
+Author-email: Val Huber <apilogicserver@gmail.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://apilogicserver.github.io/Docs/
+Project-URL: Source, https://github.com/ApiLogicServer/ApiLogicServer-src
+Project-URL: Issues, https://github.com/ApiLogicServer/ApiLogicServer-src/issues
+Keywords: Flask,SQLAlchemy,Rules,WebApp,Microservice,ReactAdmin,Angular
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyJWT==2.6.0
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: SQLAlchemy-Utils==0.38.2
+Requires-Dist: logicbankutils==0.6.0
+Requires-Dist: inflect==5.0.2
+Requires-Dist: inflection==0.5.1
+Requires-Dist: Flask==2.3.2
+Requires-Dist: Flask-Cors==3.0.10
+Requires-Dist: Flask-RESTful>=0.3.9
+Requires-Dist: flask-restful-swagger-2>=0.35
+Requires-Dist: Flask-SQLAlchemy==3.0.3
+Requires-Dist: flask-swagger-ui>=4.11.1
+Requires-Dist: flask_bcrypt==1.0.1
+Requires-Dist: itsdangerous==2.1.2
+Requires-Dist: Jinja2==3.1.5
+Requires-Dist: MarkupSafe==2.1.3
+Requires-Dist: six==1.16.0
+Requires-Dist: SQLAlchemy==2.0.15
+Requires-Dist: Werkzeug==2.3.3
+Requires-Dist: safrs>=3.1.6
+Requires-Dist: Flask-Admin==1.5.7
+Requires-Dist: Flask-JWT-Extended==4.4.4
+Requires-Dist: Flask-Login==0.6.2
+Requires-Dist: Flask-OpenID==1.3.0
+Requires-Dist: python-dotenv==0.15.0
+Requires-Dist: email-validator==1.1.1
+Requires-Dist: LogicBank>=1.20.26
+Requires-Dist: cryptography==36.0.1
+Requires-Dist: rsa
+Requires-Dist: PyMySQL==1.0.3
+Requires-Dist: oracledb==2.1.2
+Requires-Dist: requests==2.31.0
+Requires-Dist: gunicorn==20.1.0
+Requires-Dist: psycopg2-binary==2.9.9
+Requires-Dist: dotmap==1.3.25
+Requires-Dist: WTForms==2.3.3
+Requires-Dist: behave==1.2.6
+Requires-Dist: alembic==1.7.7
+Requires-Dist: python-ulid==2.7.0
+Requires-Dist: psutil==6.0.0
+Requires-Dist: pandas==2.2.2
+Requires-Dist: openpyxl==3.1.5
+Requires-Dist: GeoAlchemy2==0.12.5
+Requires-Dist: confluent-kafka==2.3.0
+Requires-Dist: translate==3.6.1
+Requires-Dist: libretranslatepy==2.1.1
+Requires-Dist: reportlab==4.2.0
+Requires-Dist: xlsxwriter==3.2.0
+Requires-Dist: natsort==8.4.0
+Requires-Dist: astor==0.8.1
+Requires-Dist: colorama==0.4.6
+Requires-Dist: openai==1.55.3
+Dynamic: license-file
+
+[![Downloads](https://pepy.tech/badge/apilogicserver)](https://pepy.tech/project/apilogicserver)
+[![Latest Version](https://img.shields.io/pypi/v/apilogicserver.svg)](https://pypi.python.org/pypi/apilogicserver/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/apilogicserver.svg)](https://pypi.python.org/pypi/apilogicserver/)
+
+&nbsp;
+
+# TL;DR
+
+Create an executable project (API and Admin App) from a database or natural language prompt with 1 command, customize with declarative rules and Python in your IDE, containerize and deploy.
+
+&nbsp;
+
+<details markdown>
+
+<summary>Video Overview (4 min)</summary>
+
+&nbsp;
+
+See how **Microservice Automation** creates and runs a microservice - a multi-page app, and an API. 
+
+* Here is a microservice -- api and admin app -- **created / running in 5 seconds**
+
+    * It would be similar for your databases
+
+* Then, customize in your IDE with Python and **Logic Automation:** spreadsheet-like rules
+
+[![GenAI Automation](https://raw.githubusercontent.com/ApiLogicServer/Docs/main/docs/images/sample-ai/copilot/genai-automation-video.png)](https://www.youtube.com/watch?v=7I33Fa9Ulos "Microservice Automation")
+
+</details>
+
+&nbsp;
+
+# Quickstart
+
+If you have a supported Python (version 3.10 - 3.12), install is standard, typically:
+
+```bash title="Install API Logic Server in a Virtual Environment"
+python3 -m venv venv                 # windows: python -m venv venv
+source venv/bin/activate             # windows: venv\Scripts\activate
+python -m pip install ApiLogicServer
+```
+
+<br>Now, verify it's working - open the Project Manager for instructions (readme), and run the demo:
+
+```bash title="Start Manager"
+ApiLogicServer start
+```
+
+Find the [user documentation here](https://apilogicserver.github.io/Docs/).  Use this for normal installation, to create and customize API Logic Projects.
+
+To install the ***dev*** version, [see here](https://apilogicserver.github.io/Docs/Architecture-Internals).  This installs the source of API Logic Server, so you can explore or extend it.
+
+&nbsp;
+
+# Welcome to API Logic Server
+
+For Developers and their organizations seeking to **increase business agility,**
+
+API Logic Server provides ***Microservice Automation:*** create executable projects with 1 command:
+
+1. ***API Automation:*** crud for each table, with pagination, optimistic locking, filtering and sorting, and
+
+2. ***App Automation:*** a multi-page, multi-table Admin App.  <br>
+
+**Customize in your IDE:** use standard tools (Python, Flask, SQLAlchemy, GitHub and Docker), plus<br>
+
+3. ***Logic Automation:*** unique **rules - 40X** more concise multi-table derivations and constraints.
+
+Unlike frameworks, weeks-to-months of complex development is no longer necessary.  <br>
+API Logic Server provides unique automation **for instant integrations and app backends**.
+
+
+&nbsp;
+
+For more information, including install procedures, [please see the docs](https://apilogicserver.github.io/Docs/).
+
+&nbsp;
+
+### Making Contributions
+
+This is an open source project.  We are open to suggestions.  Some of our ideas include:
+
+| Component           | Provides         | Consider Adding                                                                |
+|:---------------------------|:-----------------|:-------------------------------------------------------------------------------|
+| 1. JSON:**API** and Swagger | API Execution    | Serverless, Kubernetes        | 
+| 2. Transactional **Logic**   | Rule Enforcement | Recompute Derivations        |
+| 3. This project | API Logic Project Creation | General support - see issues |
+| 3. GenAI | Web version | Create projects with logic |
+
+&nbsp;