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

api_logic_server_cli/cli.py

@@ -221,7 +221,7 @@ def main(ctx):
               help="Create sample projects")
 @click.option('--open-manager/--no-open-manager', "open_manager",
               default=True, is_flag=True,
-              help="Overlay existing manager (projects retained)")
+              help="Whether to open IDE at Manager")
 def create_start_manager(ctx, open_with, clean: click.BOOL = True, samples: click.BOOL = True,
                          volume: str = "ApiLogicServer", open_manager: click.BOOL = True):
     """
@@ -615,14 +615,14 @@ def genai(ctx, using, db_url, repaired_response: str,
         Creates new customizable project (overwrites).
     """
     global command
-    import api_logic_server_cli.genai.genai as genai_svcs
+    import api_logic_server_cli.genai.genai as genai
     if using is None and repaired_response is None:
         log.error("Error - must provide --using or --repaired-response")
         exit(1) 
     defaulted_using = using
     if defaulted_using == 'genai_demo': # default to genai_demo.prompt
         defaulted_using = 'system/genai/examples/genai_demo/genai_demo.prompt'
-    genai_svcs.genai_cli_with_retry(using=defaulted_using, db_url=db_url, repaired_response=repaired_response, 
+    genai.genai_cli_with_retry(using=defaulted_using, db_url=db_url, repaired_response=repaired_response, 
                 genai_version=genai_version, temperature=temperature,
                 retries=retries, opt_locking=opt_locking, genai_active_rules=active_rules,
                 prompt_inserts=prompt_inserts, quote=quote, use_relns=use_relns, 
@@ -745,8 +745,11 @@ def genai_logic(ctx, using, genai_version: str, retries: int, suggest: click.BOO
 @click.option('--genai-version', 'genai_version',
               default='gpt-4o',
               help="Eg, gpt-3.5-turbo, gpt-4o")
+@click.option('--replace-with', 'replace_with',
+              default='!using',
+              help="Replace Graphics with this (*/retry, ''/delete)")
 @click.pass_context
-def genai_graphics(ctx, using, genai_version: str):
+def genai_graphics(ctx, using, genai_version: str, replace_with: str):
     """
         Adds (or suggests) logic to current project.
     """
@@ -771,7 +774,7 @@ def genai_graphics(ctx, using, genai_version: str):
         log.info(f'... Typical usage - cd into project, use --project_name=. \n')
         exit (1)
     from api_logic_server_cli.genai.genai_graphics import GenAIGraphics
-    genai_graphics = GenAIGraphics(using=using, project=project, genai_version=genai_version)
+    genai_graphics = GenAIGraphics(using=using, project=project, genai_version=genai_version, replace_with=replace_with)
     pass
     log.info("")
 
@@ -1451,17 +1454,23 @@ def add_auth_cmd(ctx, bind_key_url_separator: str, provider_type :str, db_url: s
 
     cd existing_project
 
-    ApiLogicServer add-auth project_name=.
+    ApiLogicServer add-auth
+
+    ApiLogicServer add-auth --db-url=add-auth
+
     ApiLogicServer add-auth provider_type=keycloak
     
     """
     project_name = resolve_blank_project_name(project_name)
     bind_key = "authentication"
+    auth_db_url = db_url
+    if db_url == "auth" and provider_type == "sql":
+        auth_db_url = "add-auth"
     project = PR.ProjectRun(command="add_security", 
               project_name=project_name, 
               api_name=api_name, 
               db_url="",
-              auth_db_url=db_url, 
+              auth_db_url=auth_db_url, 
               auth_provider_type=provider_type,
               bind_key=bind_key,
               bind_key_url_separator=bind_key_url_separator,
@@ -1586,36 +1595,46 @@ def add_cust(ctx, bind_key_url_separator: str, api_name: str, project_name: str)
     project_name = project.project_directory_path.parent.name if not project.project_directory_path.is_dir() else project.project_directory_path.name
     models_py_path = project.project_directory_path.joinpath('database/models.py')
 
-    log.debug(f"\ncli[add-cust] models_py_path={models_py_path}")
-    if not models_py_path.exists():
-        raise Exception("Customizations are northwind/genai-specific - models.py does not exist")
+    if use_add_cust := True:
+        import api_logic_server_cli.add_cust.add_cust as add_cust
+        add_cust.add_cust(project=project, project_name=project_name, models_py_path=models_py_path)
+        pass
+    else:
+        log.debug(f"\ncli[add-cust] models_py_path={models_py_path}")
+        if not models_py_path.exists():
+            raise Exception("Customizations are northwind/genai-specific - models.py does not exist")
+
+        project_is_genai_demo = False  # can't use project.is_genai_demo because this is not the create command...
+        if project.project_directory_path.joinpath('docs/project_is_genai_demo.txt').exists():
+            project_is_genai_demo = True
+        
+        project.abs_db_url, project.nw_db_status, project.model_file_name = create_utils.get_abs_db_url("0. Using Sample DB", project)
+
+        if create_utils.does_file_contain(search_for="CategoryTableNameTest", in_file=models_py_path):
+            project.add_nw_customizations(do_security=False)
+            log.info("\nNext step - add authentication:\n  $ ApiLogicServer add-auth --db_url=auth\n\n")
+
+        elif project_is_genai_demo and create_utils.does_file_contain(search_for="Customer", in_file=models_py_path):
+            project.add_genai_customizations(do_security=False)
+
+        elif project_name == 'sample_ai' and create_utils.does_file_contain(search_for="CustomerName = Column(Text", in_file=models_py_path):
+            cocktail_napkin_path = project.project_directory_path.joinpath('logic/cocktail-napkin.jpg')
+            is_customized = cocktail_napkin_path.exists()
+            if not is_customized:
+                project.add_sample_ai_customizations()
+            else:
+                project.add_sample_ai_iteration()
+
+        elif project_name == 'basic_demo' and create_utils.does_file_contain(search_for="Customer", in_file=models_py_path):
+            cocktail_napkin_path = project.project_directory_path.joinpath('logic/cocktail-napkin.jpg')
+            is_customized = cocktail_napkin_path.exists()
+            if not is_customized:
+                project.add_basic_demo_customizations()
+            else:
+                project.add_basic_demo_iteration()
 
-    project_is_genai_demo = False  # can't use project.is_genai_demo because this is not the create command...
-    if project.project_directory_path.joinpath('docs/project_is_genai_demo.txt').exists():
-        project_is_genai_demo = True
-    
-    project.abs_db_url, project.nw_db_status, project.model_file_name = create_utils.get_abs_db_url("0. Using Sample DB", project)
-    if create_utils.does_file_contain(search_for="CategoryTableNameTest", in_file=models_py_path):
-        project.add_nw_customizations(do_security=False)
-        log.info("\nNext step - add authentication:\n  $ ApiLogicServer add-auth --db_url=auth\n\n")
-    elif project_is_genai_demo and create_utils.does_file_contain(search_for="Customer", in_file=models_py_path):
-        project.add_genai_customizations(do_security=False)
-    elif project_name == 'sample_ai' and create_utils.does_file_contain(search_for="CustomerName = Column(Text", in_file=models_py_path):
-        cocktail_napkin_path = project.project_directory_path.joinpath('logic/cocktail-napkin.jpg')
-        is_customized = cocktail_napkin_path.exists()
-        if not is_customized:
-            project.add_sample_ai_customizations()
-        else:
-            project.add_sample_ai_iteration()
-    elif project_name == 'basic_demo' and create_utils.does_file_contain(search_for="Customer", in_file=models_py_path):
-        cocktail_napkin_path = project.project_directory_path.joinpath('logic/cocktail-napkin.jpg')
-        is_customized = cocktail_napkin_path.exists()
-        if not is_customized:
-            project.add_basic_demo_customizations()
         else:
-            project.add_basic_demo_iteration()
-    else:
-        raise Exception("Customizations are northwind/genai-specific - models.py has neither CategoryTableNameTest nor Customer")
+            raise Exception("Customizations are northwind/genai-specific - models.py has neither CategoryTableNameTest nor Customer")
 
 
 @main.command("sample-ai", cls=HideDunderCommand, hidden=True) 

api_logic_server_cli/create_from_model/api_logic_server_utils.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 
+import shutil
 import subprocess, os, sys
 from pathlib import Path
 from os.path import abspath
@@ -335,6 +336,7 @@ def get_config(search_for: str, in_file: str) -> str:
                             f'.. seeking {search_for}\n'
                             f'.. in {in_file}')
         return file_lines[insert_line].split('=')[1].strip().replace("'","",2)
+
 def get_ontimize_apps(project_dir_path):
     result = []
     for name in os.listdir(f"{project_dir_path}/ui"):
@@ -346,6 +348,7 @@ def get_ontimize_apps(project_dir_path):
                         result.append(name)    
     log.debug(f"Found {len(result)} Ontimize app(s)")          
     return result
+
 def does_file_contain(search_for: str, in_file: str) -> bool:
     """ returns True if <search_for> is <in_file> """
     with open(Path(in_file), 'r+') as fp:
@@ -482,3 +485,47 @@ def run_command(cmd: str, env=None, msg: str = "", new_line: bool=False,
     elif result != "" and result != "Downloaded the skeleton app, good coding!":
         log.debug(f'{log_msg} {cmd_to_run} result: {spaces}{result}')
     return result.replace('\\n','\n')
+
+
+def recursive_overwrite(src, dest, ignore=None):
+    """
+    copyTree, with overwrite
+    thanks: https://stackoverflow.com/questions/12683834/how-to-copy-directory-recursively-in-python-and-overwrite-all
+    """
+    if os.path.isdir(src):
+        if not os.path.isdir(dest):
+            os.makedirs(dest)
+        files = os.listdir(src)
+        if ignore is not None:
+            ignored = ignore(src, files)
+        else:
+            ignored = set()
+        for f in files:
+            if f not in ignored:
+                recursive_overwrite(os.path.join(src, f),
+                                    os.path.join(dest, f),
+                                    ignore)
+    else:
+        shutil.copyfile(src, dest)
+
+def find_replace_recursive(directory, find, replace, filePattern):
+    """
+
+    find_replace_recursive("some_dir", "find this", "replace with this", "*.txt")
+
+    thanks: https://stackoverflow.com/questions/4205854/recursively-find-and-replace-string-in-text-files
+
+    Args:
+        directory (_type_): _description_
+        find (_type_): _description_
+        replace (_type_): _description_
+        filePattern (_type_): _description_
+    """
+    for path, dirs, files in os.walk(os.path.abspath(directory)):
+        for filename in fnmatch.filter(files, filePattern):
+            filepath = os.path.join(path, filename)
+            with open(filepath) as f:
+                s = f.read()
+            s = s.replace(find, replace)
+            with open(filepath, "w") as f:
+                f.write(s)

api_logic_server_cli/create_from_model/create_db_from_model.py

@@ -12,6 +12,8 @@ log = logging.getLogger('create_from_model.model_creation_services')
 def create_db(project: Project):
     """ Create a database from a model file
 
+    Warning - test data failure is not reported here
+
     Args:
         project (Project): contains the model file and db_url locations
     """

api_logic_server_cli/create_from_model/dbml.py

@@ -1,3 +1,4 @@
+import json
 import logging
 from re import X
 import shutil
@@ -68,51 +69,55 @@ class DBMLCreator(object):
         self.dbms_lines.append('// Or, https://databasediagram.com/app')
         self.dbms_lines.append('// Or, view in VSCode with extension: "DBML Live Preview"')
         self.dbms_lines.append("")
+        self.mcp_schema = \
+            {
+                "tool_type": "json-api",
+                "schema_version": "1.0",
+                "base_url": "http://localhost:5656/api",
+                "description": f"API Logic Project: {self.mod_gen.project.project_name_last_node}",
+                "resources": [
+                ]
+            }
+        
 
-    def create_docs_dbml_file(self):
-        """ main driver - loop through resources, write admin.yaml - with backup, nw customization
-
-        Table Users {
-            id integerish
-            created_at timestamp 
-            }        
-        Ref: users.(id) < follows.(followed_user_id)
+    def do_process_resource(self, resource_name: str)-> bool:
+        """ filter out resources that are skipped by user, start with ab etc
         """
+        if "ProductDetails_V" in resource_name:
+            log.debug("special table")  # should not occur (--noviews)
+        if resource_name.startswith("ab_"):
+            return False  # skip admin table: " + table_name + "\n
+        elif 'sqlite_sequence' in resource_name:
+            return False  # skip sqlite_sequence table: " + table_name + "\n
+        elif resource_name is None:
+            return False  # no class (view): " + table_name + "\n
+        elif resource_name.startswith("Ab"):
+            return False
+        return True
 
-        ''' decide about rebuild -- can you save positions?
-        if (self.mod_gen.project.command == "create-ui" or self.mod_gen.project.command.startswith("rebuild")) \
-                                                                  or self.mod_gen.project.command == "add_db":
-            if self.mod_gen.project.command.startswith("rebuild"):
-                log.debug(".. .. ..Use existing ui/admin directory")
-        else:
-            self.create_admin_app(msg=".. .. ..Create ui/admin")
-        '''
-
-        sys.path.append(self.mod_gen.project.os_cwd)
-
-        if do_table_descriptions := True:
-            if len(self.mod_gen.project.table_descriptions) > 0:
-                self.dbms_lines.append("Project DBML {")
-                self.dbms_lines.append("  Note: '''")
-                for each_resource_name in self.mod_gen.resource_list:
-                    if self.do_process_resource(each_resource_name):
-                        each_resource : Resource = self.mod_gen.resource_list[each_resource_name]
-                        description = "missing (requires genai creation)"
-                        table_descriptions = self.mod_gen.project.table_descriptions
-                        if each_resource.table_name in table_descriptions:
-                            # als model desc's: api_logic_server_cli/sqlacodegen_wrapper/sqlacodegen/sqlacodegen/codegen.py
-                            description = table_descriptions[each_resource.table_name]
-                            description = description.replace("Table representing ", "")
-                            description = description.replace("Table storing ", "")
-                            description = description.replace("This table stores ", "")
-                            description = description.replace("This table lists ", "")
-                            description = description.replace("This table records ", "")
-                        self.dbms_lines.append(f"{each_resource_name}: {description}")
-                self.dbms_lines.append("'''")
-                self.dbms_lines.append("}")
-                self.dbms_lines.append("")
-
-
+    def dbml_descriptions(self):
+        if len(self.mod_gen.project.table_descriptions) > 0:
+            self.dbms_lines.append("Project DBML {")
+            self.dbms_lines.append("  Note: '''")
+            for each_resource_name in self.mod_gen.resource_list:
+                if self.do_process_resource(each_resource_name):
+                    each_resource : Resource = self.mod_gen.resource_list[each_resource_name]
+                    description = "missing (requires genai creation)"
+                    table_descriptions = self.mod_gen.project.table_descriptions
+                    if each_resource.table_name in table_descriptions:
+                        # als model desc's: api_logic_server_cli/sqlacodegen_wrapper/sqlacodegen/sqlacodegen/codegen.py
+                        description = table_descriptions[each_resource.table_name]
+                        description = description.replace("Table representing ", "")
+                        description = description.replace("Table storing ", "")
+                        description = description.replace("This table stores ", "")
+                        description = description.replace("This table lists ", "")
+                        description = description.replace("This table records ", "")
+                    self.dbms_lines.append(f"{each_resource_name}: {description}")
+            self.dbms_lines.append("'''")
+            self.dbms_lines.append("}")
+            self.dbms_lines.append("")
+
+    def dbml_resources(self):
         for each_resource_name in self.mod_gen.resource_list:
             if self.do_process_resource(each_resource_name):
                 each_resource : Resource = self.mod_gen.resource_list[each_resource_name]
@@ -127,9 +132,7 @@ class DBMLCreator(object):
                 self.dbms_lines.append("    }")
                 self.dbms_lines.append("")
 
-        self.dbms_lines.append("")
-        self.dbms_lines.append("")
-        self.dbms_lines.append("// Relationships")  # Ref: users.(id) < follows.(followed_user_id)
+    def dbml_relationships(self):
         for each_resource_name in self.mod_gen.resource_list:
             if self.do_process_resource(each_resource_name):
                 each_resource : Resource = self.mod_gen.resource_list[each_resource_name]
@@ -152,6 +155,36 @@ class DBMLCreator(object):
                         if each_resource_reln.parent_resource == 'Location':  # multi-field key example in nw
                             debug_stop = 'good breakpoint'  # '    Ref: Order.(City, Country) < Location.(?, ?)'
 
+    def create_docs_dbml_file(self):
+        """ main driver - loop through resources, write admin.yaml - with backup, nw customization
+
+        Table Users {
+            id integerish
+            created_at timestamp 
+            }        
+        Ref: users.(id) < follows.(followed_user_id)
+        """
+
+        ''' decide about rebuild -- can you save positions?
+        if (self.mod_gen.project.command == "create-ui" or self.mod_gen.project.command.startswith("rebuild")) \
+                                                                  or self.mod_gen.project.command == "add_db":
+            if self.mod_gen.project.command.startswith("rebuild"):
+                log.debug(".. .. ..Use existing ui/admin directory")
+        else:
+            self.create_admin_app(msg=".. .. ..Create ui/admin")
+        '''
+
+        sys.path.append(self.mod_gen.project.os_cwd)
+
+        if do_table_descriptions := True:
+            self.dbml_descriptions()
+
+        self.dbml_resources()
+
+        self.dbms_lines.append("")
+        self.dbms_lines.append("")
+        self.dbms_lines.append("// Relationships")  # Ref: users.(id) < follows.(followed_user_id)
+        self.dbml_relationships()
         
         expose_docs_path = Path(self.mod_gen.project_directory).joinpath('docs')
         expose_docs_path.mkdir(parents=True, exist_ok=True)
@@ -162,20 +195,41 @@ class DBMLCreator(object):
 
 
 
-    def do_process_resource(self, resource_name: str)-> bool:
-        """ filter out resources that are skipped by user, start with ab etc
+    def create_mcp_json_file(self):
+        """ create docs/mcp_schema.json - create self.mcp_schema['resources'] entries like:
+
+        '''
+            {
+            "name": "Customer",
+            "path": "/Customer",
+            "methods": ["GET", "PATCH"],
+            "fields": ["id", "name", "balance", "credit_limit"],
+            "filterable": ["name", "credit_limit"],
+            "example": "List customers with credit over 5000"
+            }
+        '''        
         """
-        if "ProductDetails_V" in resource_name:
-            log.debug("special table")  # should not occur (--noviews)
-        if resource_name.startswith("ab_"):
-            return False  # skip admin table: " + table_name + "\n
-        elif 'sqlite_sequence' in resource_name:
-            return False  # skip sqlite_sequence table: " + table_name + "\n
-        elif resource_name is None:
-            return False  # no class (view): " + table_name + "\n
-        elif resource_name.startswith("Ab"):
-            return False
-        return True
+        
+        resources : list = self.mcp_schema['resources']
+        for each_resource_name in self.mod_gen.resource_list:
+            if self.do_process_resource(each_resource_name):
+                each_inserted_resource = {}
+                each_resource : Resource = self.mod_gen.resource_list[each_resource_name]
+                each_inserted_resource['name'] = each_resource.name
+                each_inserted_resource['path'] = '/' + each_resource.name
+                each_inserted_resource['methods'] = ["GET", "PATCH", "POST", "DELETE"]
+                each_inserted_resource['fields'] = []
+                for each_attr in each_resource.attributes:
+                    each_inserted_resource['fields'].append(each_attr.name)
+                each_inserted_resource['filterable'] = each_inserted_resource['fields']
+                resources.append(each_inserted_resource)
+        docs_path = Path(self.mod_gen.project_directory).joinpath('docs')
+        docs_path.mkdir(parents=True, exist_ok=True)
+        mcp_schema_path = Path(self.mod_gen.project_directory).joinpath('docs/mcp_schema.json')
+        # write self.mcp_schema dict to json file
+        with open(mcp_schema_path, 'w') as f:
+            json.dump(self.mcp_schema, f, indent=4)
+        
 
 
 def create(model_creation_services: create_from_model.ModelCreationServices):
@@ -183,4 +237,5 @@ def create(model_creation_services: create_from_model.ModelCreationServices):
     """
     dbml_creator = DBMLCreator(model_creation_services)
     dbml_creator.create_docs_dbml_file()
+    dbml_creator.create_mcp_json_file()