Merge pull request #77 from ansari-project/code-reorg

Moving files around to adhere to Python standards

Author: waleedkadous

.github/workflows/python-app.yml

@@ -28,7 +28,8 @@ jobs:
       WHATSAPP_BUSINESS_PHONE_NUMBER_ID: ${{ secrets.WHATSAPP_BUSINESS_PHONE_NUMBER_ID }}
       WHATSAPP_ACCESS_TOKEN_FROM_SYS_USER: ${{ secrets.WHATSAPP_ACCESS_TOKEN_FROM_SYS_USER }}
       WHATSAPP_VERIFY_TOKEN_FOR_WEBHOOK: ${{ secrets.WHATSAPP_VERIFY_TOKEN_FOR_WEBHOOK }}
-    
+      PYTHONPATH: src
+
     container: python:3.10
     services:
       postgres:

main_file.py

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ansari-backend"
+version = "0.1.0"
+description = "Ansari is an AI assistant to enhance understanding and practice of Islam."
+authors = [
+    { name = "Ansari Project", email = "[email protected]" }
+]
+requires-python = ">=3.8"
+
+[project.urls]
+Homepage = "https://github.com/ansari-project/ansari-backend"
+Documentation = "https://github.com/ansari-project/ansari-backend"
+Source = "https://github.com/ansari-project/ansari-backend"
+Tracker = "https://github.com/ansari-project/ansari-backend/issues"
+
+[tool.ruff]
+line-length = 88
+lint.select = ["E", "F", "W"]
+lint.ignore = ["E501"]

pyproject.toml

@@ -0,0 +1,3 @@
+[pytest]
+markers =
+    asyncio: mark a test as asyncio

pytest.ini

@@ -1,4 +1,5 @@
 bcrypt
+build
 discord.py
 diskcache
 fastapi
@@ -14,10 +15,13 @@ psycopg2-binary
 pydantic_settings
 pyislam
 pyjwt
+pytest-asyncio
 rich
 sendgrid
+setuptools
 tenacity
 tiktoken
 typer
 uvicorn
+wheel
 zxcvbn

requirements.txt

@@ -0,0 +1,4 @@
+# This file marks the directory as a Python package.
+from .config import Settings, get_settings
+
+__all__ = ["Settings", "get_settings"]

src/ansari/__init__.py

@@ -0,0 +1,4 @@
+from .ansari import Ansari
+from .ansari_workflow import AnsariWorkflow
+
+__all__ = ["Ansari", "AnsariWorkflow"]

src/ansari/agents/__init__.py

@@ -2,8 +2,6 @@
 import json
 import logging
 import os
-import re
-import sys
 import time
 import traceback
 from datetime import date, datetime
@@ -12,11 +10,11 @@
 import litellm
 from langfuse.decorators import langfuse_context, observe
 
-from config import get_settings
-from tools.search_hadith import SearchHadith
-from tools.search_vectara import SearchVectara
-from tools.search_quran import SearchQuran
-from util.prompt_mgr import PromptMgr
+from ansari.config import get_settings
+from ansari.tools.search_hadith import SearchHadith
+from ansari.tools.search_vectara import SearchVectara
+from ansari.tools.search_quran import SearchQuran
+from ansari.util.prompt_mgr import PromptMgr
 
 logger = logging.getLogger(__name__ + ".Ansari")
 logging_level = get_settings().LOGGING_LEVEL.upper()
@@ -49,7 +47,7 @@ def __init__(self, settings, message_logger=None, json_format=False):
             sm.get_tool_name(): sm,
         }
         self.model = settings.MODEL
-        self.pm = PromptMgr()
+        self.pm = PromptMgr(src_dir=settings.PROMPT_PATH)
         self.sys_msg = self.pm.bind(settings.SYSTEM_PROMPT_FILE_NAME).render()
         self.tools = [
             x.get_tool_description() for x in self.tool_name_to_instance.values()

agents/ansari.py renamed to src/ansari/agents/ansari.py

@@ -6,10 +6,10 @@
 
 import litellm
 
-from tools.search_hadith import SearchHadith
-from tools.search_vectara import SearchVectara
-from tools.search_quran import SearchQuran
-from util.prompt_mgr import PromptMgr
+from ansari.tools.search_hadith import SearchHadith
+from ansari.tools.search_vectara import SearchVectara
+from ansari.tools.search_quran import SearchQuran
+from ansari.util.prompt_mgr import PromptMgr
 
 logger = logging.getLogger(__name__ + ".AnsariWorkflow")
 

agents/ansari_workflow.py renamed to src/ansari/agents/ansari_workflow.py

@@ -2,15 +2,15 @@
 import logging
 from contextlib import contextmanager
 from datetime import datetime, timedelta, timezone
-
+from typing import Union
 import bcrypt
 import jwt
 import psycopg2
 import psycopg2.pool
 from fastapi import HTTPException, Request
 from jwt import ExpiredSignatureError, InvalidTokenError
 
-from config import Settings, get_settings
+from ansari.config import Settings, get_settings
 
 logger = logging.getLogger(__name__)
 logging_level = get_settings().LOGGING_LEVEL.upper()
@@ -588,7 +588,7 @@ def store_quran_answer(self, surah: int, ayah: int, question: str, ansari_answer
                 )
                 conn.commit()
 
-    def get_quran_answer(self, surah: int, ayah: int, question: str) -> str | None:
+    def get_quran_answer(self, surah: int, ayah: int, question: str) -> Union[str, None]:
         """
         Retrieve the stored answer for a given surah, ayah, and question.
 
@@ -612,7 +612,6 @@ def get_quran_answer(self, surah: int, ayah: int, question: str) -> str | None:
                     """
                     cur.execute(select_cmd, (surah, ayah, question))
                     result = cur.fetchone()
-                    
                     if result:
                         return result[0]
                     else: