ApiLogicServer 15.0.10__py3-none-any.whl → 15.0.14__py3-none-any.whl

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/logic/readme_declare_logic.md

@@ -1,172 +0,0 @@
-This describes how to use Logic; for more information, [see here](https://apilogicserver.github.io/Docs/Logic-Why).
-
-> Key Takeway -  Logic: Multi-table Derivation and Constraint Rules, Extensible with Python 
-<br>Rules are:
-<br>1. **Declared** in your IDE - 40X more concise
-<br>2. **Activated** on server start
-<br>3. **Executed** - *automatically* -  on updates (using SQLAlchemy events)
-<br>4. **Debugged** in your IDE, and with the console log
-<br>For more on rules, [click here](https://apilogicserver.github.io/Docs/Logic-Why/).
-
-&nbsp;
-
-## Examples      
-Examples from tutorial project:
-* Examples drawn from [tutorial project](https://github.com/ApiLogicServer/demo/blob/main/logic/declare_logic.py)
-* Use Shift + "." to view in project mode
-
-You can [find the rules here](https://apilogicserver.github.io/Docs/Logic).  Below, we explore the syntax of 3 typical rules.
-
-&nbsp;
-
-### 1. Multi-Table Derivations
-
-This declares the Customer.Balance as the sum of the unshipped Order.AmountTotal:
-
-```python
-    Rule.sum(derive=models.Customer.Balance,
-            as_sum_of=models.Order.AmountTotal,
-            where=lambda row: row.ShippedDate is None)
-```
-It means the rule engine **watches** for these changes:
-* Order inserted/deleted, or
-* AmountTotal or ShippedDate or CustomerID changes
-
-Iff changes are detected, the engine **reacts** by *adjusting* the Customer.Balance.  SQLs are [optimized](#declarative-logic-important-notes).
-
-This would **chain** to check the Customers' Constraint rule, described below.
-
-&nbsp;
-
-### 2. Constraints: lambda or function
-
-Constraints are multi-field conditions which must be true for transactions to succeed (else an exception is raised).  You can express the condition as a lambda or a function:
-
-**As a lambda:**
-```python
-    Rule.constraint(validate=models.Customer,
-        as_condition=lambda row: row.Balance <= row.CreditLimit,  # parent references are supported
-        error_msg="balance ({row.Balance}) exceeds credit ({row.CreditLimit})")
-```
-
-**Or, as a function:**
-```python
-    def check_balance(row: models.Customer, old_row: models.Customer, logic_row: LogicRow):
-        if logic_row.ins_upd_dlt != "dlt":  # see also: logic_row.old_row
-            return row.Balance <= row.CreditLimit
-        else:
-            return True
-
-    Rule.constraint(validate=models.Customer,
-        calling=check_balance,
-        error_msg=f"balance ({row.Balance}) exceeds credit ({row.CreditLimit})")
-```
-
-&nbsp;
-
-### 3. Row Events: Extensible with Python
-
-Events are procedural Python code, providing extensibility for declarative rules:
-```python
-    def congratulate_sales_rep(row: models.Order, old_row: models.Order, logic_row: LogicRow):
-        pass  # event code here - sending email, messages, etc.
-
-    Rule.commit_row_event(on_class=models.Order, calling=congratulate_sales_rep)
-```
-Note there are multiple kinds of events, so you can control whether they run before or after rule execution.  For more information, [see here](https://apilogicserver.github.io/Docs/Logic-Type-Constraint).
-
-&nbsp;
-
-## LogicRow: old_row, verb, etc
-
-A key argument to functions is `logic_row`:
-
-* **Wraps row and old_row,** plus methods for insert, update and delete - rule enforcement
-
-* **Additional instance variables:** ins_upd_dlt, nest_level, session, etc.
-
-* **Helper Methods:** are_attributes_changed, set_same_named_attributes, get_parent_logic_row(role_name), get_derived_attributes, log, is_inserted, etc
-
-Here is an example:
-
-```python
-"""
-    STATE TRANSITION LOGIC, using old_row
-"""
-def raise_over_20_percent(row: models.Employee, old_row: models.Employee, logic_row: LogicRow):
-    if logic_row.ins_upd_dlt == "upd" and row.Salary > old_row.Salary:
-        return row.Salary >= Decimal('1.20') * old_row.Salary
-    else:
-        return True
-
-Rule.constraint(validate=models.Employee,
-                calling=raise_over_20_percent,
-                error_msg="{row.LastName} needs a more meaningful raise")
-```
-
-Note the `log` method, which enables you to write row/old_row into the log with a short message:
-
-```python
-logic_row.log("no manager for this order's salesrep")
-```
-
-&nbsp;
-
-## Declarative Logic: Important Notes
-
-Logic *declarative*, which differs from conventional *procedural* logic:
-
-1. **Automatic Invocation:** you don't call the rules; they execute in response to updates (via SQLAlchemy events).
-
-2. **Automatic Ordering:** you don't order the rules; execution order is based on system-discovered depencencies.
-
-3. **Automatic Optimizations:** logic is optimized to reduce SQLs.
-
-    * Rule execution is *pruned* if dependent attributes are not altered
-    * SQL is optimized, e.g., `sum` rules operate by *adjustment*, not expensive SQL `select sum`
-
-These simplify maintenance / iteration: you can be sure new logic is always called, in the correct order.
-
-&nbsp;
-
-## Debugging
-
-Debug rules using **system-generated logic log** and your **IDE debugger**; for more information, [see here](https://apilogicserver.github.io/Docs/Logic-Use).
-
-&nbsp;
-
-### Using the debugger
-
-Use the debugger as shown below.  Note you can stop in lambda functions.
-
-![Logic Debugger](https://apilogicserver.github.io/Docs/images/logic/logic-debug.png)
-
-&nbsp;
-
-### Logic Log
-
-Logging is performed using standard Python logging, with a logger named `logic_logger`.  Use `info` for tracing, and `debug` for additional information (e.g., all declared rules are logged).
-
-In addition, the system logs all rules that fire, to aid in debugging.  Referring the the screen shot above:
-
-*   Each line represents a rule execution, showing row state (old/new values), and the _{reason}_ that caused the update (e.g., client, sum adjustment)
-*   Log indention shows multi-table chaining
-
-&nbsp;
-
-## How Logic works
-
-*Activation* occurs in `api_logic_server_run.py`:
-```python
-    LogicBank.activate(session=session, activator=declare_logic, constraint_event=constraint_handler)
-```
-
-This installs the rule engine as a SQLAlchemy event listener (`before_flush`).  So, Logic *runs* automatically, in response to transaction commits (typically via the API).
-
-Rules plug into SQLAlchemy events, and execute as follows:
-
-| Logic Phase | Why It Matters |
-|:-----------------------------|:---------------------|
-| **Watch** for changes at the attribute level | Performance - Automatic Attribute-level Pruning |
-| **React** by recomputing value | Ensures Reuse - Invocation is automatic<br>Derivations are optimized (e.g. *adjustment updates* - not aggregate queries) |
-| **Chain** to other referencing data | Simplifies Maintenance - ordering is automatic<br>Multi-table logic automation |

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/readme.md

@@ -1,266 +0,0 @@
-# Quick Start
-
-**Microservice Automation Complete -- run to verify:** for **VSCode** projects except those downloaded from Web/GenAI:
-1. `Press F5 to Run` (your venv is defaulted)  
-
-    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+`
-
- 
-
-# Using this readme
-
-This readme contains the following sections:
-
-
-| Section                  | Info                               |
-|:-------------------------|:-----------------------------------|
-| [1. Setup and Run](#1-setup-and-run) | Information about API Logic Server, and setting up your venv     |
-| [2. Key Customization Files](#2-key-customization-files) | Quick idea of the key files you'll alter        |
-| [3. Procedures](#3-procedures) | Key Procedures        |
-| [4. Deployment](#4-deployment) | Deploy early previews to the cloud - enable team collaboration     |
-| [5. Project Requirements](#5-project-requirements)     | Options for capturing requirements |
-| [6. Project Information](#6-project-information)                | Creation dates, versions          |
-| [Appendix - Key Technologies](#appendix-key-technologies)    | Doc links of key libraries         |
-
- 
-
-# 1. Setup and Run
-
-To run your project, the system requires various runtime systems for data access, api, and logic.  These are included with API Logic Server ([architecture doc here](https://apilogicserver.github.io/Docs/Architecture-What-Is/)).  
-
-So, to run your project:
-
-*  __1.1 Establish your Python Environment__ 
-    * Docker or VSCode - [nothing to do](#docker-or-vscode---nothing-to-do)
-    * Otherwise, [Establish Your Python Environment](#establish-your-python-environment---other-environments) to activate these runtime systems
-* __[1.2 Run](#12-run)__
-
- 
-
-## 1.1 Establish Your Python Environment - Other Environments
-
-Your `requirements.txt` has already been created, so...
-
-```bash title="Install API Logic Server in a Virtual Environment"
-python -m venv venv                        # may require python3 -m venv venv
-venv\Scripts\activate                      # mac/linux: source venv/bin/activate
-python -m pip install -r requirements.txt  # accept "new Virtual environment"
-```
-
-Notes:
-
-* See also the `venv_setup` directory in this API Logic Project.
-
-* If using SqlServer, install `pyodbc`.  Not required for docker-based projects.  For local installs, see the [Quick Start](https://apilogicserver.github.io/Docs/Install-pyodbc/).
-
- 
-
-#### Docker or VSCode - nothing to do
-
-Nothing to do here:
-
-* **VSCode:** projects automatically use installed API Logic Server `venv`, so this step is ***not required*** until you want to create a local `venv` for additional packages.
-
-* **Docker:** Your runtime systems are part of Dev Container, which you probably activated when you [opened the project](https://apilogicserver.github.io/Docs/IDE-Execute/).  
-
-    * If you did not accept the "Open in Container" option when you started VSCode, use __View > Command Palette > Remote-Containers: Reopen in Container__.
-
- 
-
- 
-
-## 1.2 Run
-
-The `ApiLogicServer create` command creates Run Configurations for PyCharm and VSCode:
-
-* For PyCharm, press Ctl-D
-* For VSCode,  press F5:
-
-![Start Project](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/tutorial/2-apilogicproject-nutshell.png?raw=true)
-
-As shown above:
-
-1. Use the pre-supplied Run Configurations; use either...
-    * `ApiLogicServer` to run [with security](https://apilogicserver.github.io/Docs/Security-Swagger/)
-    * `ApiLogicServer - No Security` (simplifies use of Swagger)
-2. Click the url in the console to start the Admin App
-    * Use it to explore your **data** (shown below)
-    * And your **API** (via Swagger)
-
-![Admin App](https://github.com/ApiLogicServer/Docs/blob/main/docs/images/ui-admin/run-admin-app.png?raw=true)
-
-
- 
-
-# 2. Key Customization Files
-
-Your project is ready to run, but it's likely you'll want to customize it - declare logic, new endpoints, etc.
-
-
-<details markdown>
-
-<summary>Important: explore customization examples</summary>
-<br>
-In particular, use the sample app to explore the value of declarative logic and security.  Unique to API Logic Server, these are critical to unlocking the full value of API Logic Server.
-
-<br>
-
-To create the sample app for customization examples: 
-
-* `ApiLogicServer create --project-name=nw_sample --db_url=nw+`
-* Or, open it in GitHub (use Shift + "." to view in project mode) - [click here](https://github.com/ApiLogicServer/demo)
-
-To make customizations easy to explore, search for:
-* `#als` will reveal key customization examples
-* `Your Code Goes Here` to find key files to customize, summarized in the table below.
-
-</details>
-
-&nbsp;
-
-The ___Key Customization Files___ listed in the table below are created as stubs, intended for you to add customizations that extend the created API, Logic and Web App.
-
-* Since they are separate files, the project can be
-[rebuilt](https://apilogicserver.github.io/Docs/Project-Rebuild/) (e.g., synchronized with a revised schema), preserving your customizations.
-
-<br>
-
-| Directory | Usage                         | Key Customization File             | Typical Customization                                                                 |
-|:-------------- |:------------------------------|:-----------------------------------|:--------------------------------------------------------------------------------------|
-| ```api``` | **JSON:API**<br>*Ready to Run*                    | ```api/customize_api.py```         | Add new end points / services                                                         |
-| ```ui``` | **Multi-Page Admin App**<br>*Ready to Run*  | ```ui/admin/admin.yaml```          | Control field display - order, captions etc.                                          |
-| ```database``` | SQLAlchemy Data Model Classes | ```database/customize_models.py``` | Add derived attributes, and relationships missing in the schema                       |
-| ```logic``` | **Transactional Logic**<br>spreadsheet-like rules   | ```logic/declare_logic.py```       | Declare multi-table derivations, constraints, and Python events such as send mail / messages |
-| ```security``` | Authentication, Authorization   | ```security/declare_security.py```          | Control login, role-based row access         |
-| ```integration``` | Consume Kafka Messages             | ```integration/kafka/kafka_consumer.py```          |  [Application Integration](https://apilogicserver.github.io/Docs/Sample-Integration/)                                          |
-| ```test``` | Behave Test Suite              | ```test/api_logic_server_behave/features```          | Declare and implement [Behave Tests](https://apilogicserver.github.io/Docs/Behave/)                                          |
-
-<br>
-
-Notes:
-
-1. API Logic Server **CLI** provides commands you can use to ugrade your project, e.g., to add security.  See the next section.
-2. You will observe the project is small.  That is because the app, logic and api are represented as **models:**
-    * The [web app](ui/admin/admin.yaml) is a YAML file (about 150 lines - no html or JavaScript)
-    * The [api](api/expose_api_models.py) is essentially 1 line per data model (table)
-
-&nbsp;
-
-# 3. Procedures
-
-Several **CLI commands** are provided to operate on your current project.  
-
-1. Use your IDE's terminal window to access these
-2. Use `ApiLogicServer --help` to discover these
-
-<br>
-
-| Procedures               | Notes                              |
-|:-------------------------|:-----------------------------------|
-| 1. **Database Migration** | See [alembic](database/alembic/readme.md) for database migration procedures.     |
-| 1. **Activating Security** | See [Security Activation](https://apilogicserver.github.io/Docs/Security-Activation/) for activating security.     |
-
-&nbsp;
-
-# 4. Deployment
-
-The `devops` directory contains several scripts for creating container images, testing them, and deploying them.
-
-Since API Logic Server creates working software (UI, API), you can do this after creating your project, to [collaborate with your team](https://apilogicserver.github.io/Docs/DevOps-Containers-Preview/).
-
-&nbsp;
-
-# 5. Project Requirements
-
-Optionally, you can **document requirements** as part of an **executable test plan**.  Test plan execution creates documentation (in markdown), including **requirements traceability** into implementation.  [See example here](test/api_logic_server_behave/reports/Behave%20Logic%20Report%20Sample.md).
-
-&nbsp;
-
-# 6. Project Information
-
-This API Logic Project was created with the `ApiLogicServer create` command.
-For information on Managing API Logic Projects, [click here](https://apilogicserver.github.io/Docs/Project-Structure).
-
-| About                    | Info                               |
-|:-------------------------|:-----------------------------------|
-| Created                  | December 21, 2024 18:44:38                      |
-| API Logic Server Version | 14.00.31           |
-| Created in directory     | genai_demo_no_logic_fixed |
-| API Name                 | api          |
-| Execution begins with    | `api_logic_server_run.py`          |
-
-
-&nbsp;
-
-# Appendix: Key Technologies
-
-API Logic Server is based on the projects shown below.
-Consult their documentation for important information.
-
-&nbsp;
-
-### SARFS JSON:API Server
-
-[SAFRS: Python OpenAPI & JSON:API Framework](https://github.com/thomaxxl/safrs)
-
-SAFRS is an acronym for SqlAlchemy Flask-Restful Swagger.
-The purpose of this framework is to help python developers create
-a self-documenting JSON API for sqlalchemy database objects and relationships.
-
-These objects are serialized to JSON and 
-created, retrieved, updated and deleted through the JSON API.
-Optionally, custom resource object methods can be exposed and invoked using JSON.
-
-Class and method descriptions and examples can be provided
-in yaml syntax in the code comments.
-
-The description is parsed and shown in the swagger web interface.
-The result is an easy-to-use
-swagger/OpenAPI and JSON:API compliant API implementation.
-
-&nbsp;
-
-### LogicBank
-[Transaction Logic for SQLAlchemy Object Models](https://apilogicserver.github.io/Docs/Logic-Why/)
-
-Use Logic Bank to govern SQLAlchemy update transaction logic - 
-multi-table derivations, constraints, and actions such as sending mail or messages. Logic consists of _both:_
-
-*   **Rules - 40X** more concise using a spreadsheet-like paradigm, and
-
-*   **Python - control and extensibility,** using standard tools and techniques
-
-Logic Bank is based on SQLAlchemy - it handles `before_flush` events to enforce your logic.
-Your logic therefore applies to any SQLAlchemy-based access - JSON:Api, Admin App, etc.
-
-&nbsp;
-
-### SQLAlchemy
-
-[Object Relational Mapping for Python](https://docs.sqlalchemy.org/en/13/).
-
-SQLAlchemy provides Python-friendly database access for Python.
-
-It is used by JSON:Api, Logic Bank, and the Admin App.
-
-SQLAlchemy processing is based on Python `model` classes,
-created automatically by API Logic Server from your database,
-and saved in the `database` directory.
-
-&nbsp;
-
-### Admin App
-
-This generated project also contains a React Admin app:
-* Multi-page - including page transitions to "drill down"
-* Multi-table - master / details (with tab sheets)
-* Intelligent layout - favorite fields first, predictive joins, etc
-* Logic Aware - updates are monitored by business logic
-
-&nbsp;
-
-### Python Tips
-
-If you are new to Python, check out [these tips](https://apilogicserver.github.io/Docs/Tech-Python/).

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/requirements.txt

@@ -1,3 +0,0 @@
-# this includes the key libraries (Flask, SQLAlchemy, SAFRS), and the API Logic Server CLI
-
-ApiLogicServer

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/run.ps1

@@ -1,30 +0,0 @@
-Set-PSDebug -Trace 0  # Use 1 for LOTS of output
-
-if ($args[0] -contains "help") {
-    Write-Output "`r`nRuns API Logic Project, using venv in:"
-    Write-Output "   - project folder (no args)"
-    Write-Output "   - calling folder (arg 1)`r`n"
-    exit 0
-}
-
-# Write-Output "`r`nRunning at caller path: $PWD, with $($args.Count) args"
-
-if ($args.count -gt 0) { 
-    # Write-Output "Using calling venv"
-    .\venv\Scripts\activate
-}
-
-# change path to project
-$prevPwd = $PWD; Set-Location -ErrorAction Stop -LiteralPath $PSScriptRoot
-# Write-Output "PWD to project: $PWD"
-
-try {
-    if ($args.count -eq 0) { 
-        # Write-Output "Using project venv: $PWD"
-        .\venv\Scripts\activate
-    }
-    python api_logic_server_run.py
-}
-finally {
-  $prevPwd | Set-Location
-}

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/run.sh

@@ -1,55 +0,0 @@
-#!/bin/bash
-
-contains()
-  # echo contains check $1 in $2
-  case "$1" in
-    (*"$2"*) true;;
-    (*) false;;
-  esac
-
-
-debug() {
-  echo "$1"
-}
-
-debug "\nAPI Logic Project Runner 1.0 Here ($# arg(s): $1 $2)"
-if [ $# -ge 1 ]
-  then
-    if contains "help" $1; then
-      echo "\nRuns API Logic Project"
-      echo "  sh run.sh [ calling | $ | help ] [ gunicorn ]"
-      echo "    arg1: specifies how to find venv; values:"
-      echo "       no args - use project venv"
-      echo "       calling - use venv from calling script (for internal tests)"
-      echo "       $ - use the current venv"
-      echo "    arg2: use gunicorn (Note: no commas)\n"
-      exit 0
-    elif [ "$1" == "$" ]; then
-      debug ".. Using existing venv -- $VIRTUAL_ENV"
-    else
-      debug ".. Calling directory - venv from pwd: $PWD"
-      cd $PWD
-      . venv/bin/activate
-    fi
-  else
-    debug " "
-    if [ "${APILOGICSERVER_RUNNING}" = "DOCKER" ]; then
-      debug ".. Docker - no venv required"
-    else
-      debug ".. APILOGICSERVER_RUNNING=${APILOGICSERVER_RUNNING} - not Docker/Codespaces - activate venv"
-      . venv/bin/activate
-    fi
-  fi
-
-export PYTHONHASHSEED=0
-cd "$(dirname "$0")"
-
-if [ $# -eq 2 ]; then
-    debug "Running with gunicorn"
-    shift
-    PORT=${APILOGICPROJECT_PORT:-5656}
-    gunicorn --log-level=info -b 0.0.0.0:${PORT} -w2 --reload api_logic_server_run:flask_app $*
-else
-    debug "run flask"
-    python api_logic_server_run.py
-fi

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/wg_dev_merge/dev_demo_no_logic_fixed/security/authentication_provider/abstract_authentication_provider.py

@@ -1,34 +0,0 @@
-from abc import ABC, abstractmethod
-
-# **************************************
-# authentication provider abstract class
-# **************************************
-
-class Abstract_Authentication_Provider():
-        
-    @staticmethod
-    @abstractmethod
-    def get_user(id: str, password: str) -> object:
-        """
-        Must return a row object with attributes name and role_list
-        role_list is a list of row objects with attribute name
-
-        row object is a DotMap or a SQLAlchemy row
-        
-        print("subclass responsibility")
-        return None
-        """
-
-    @staticmethod
-    @abstractmethod
-    def check_password(user: object, password: str) -> bool:
-        """_summary_
-
-        Args:
-            user (object): DotMap or SQLAlchemy row containing id and maybe password
-
-        Returns:
-            bool: whether password matches
-        """
-        return False
-