add poe tasks

README.md

@@ -59,17 +59,25 @@ The backend API provides the following endpoint:
 The repository includes a Dockerfile to build and run the backend service. To build the image:
 
 ```bash
-docker build -t prompt-search-engine .
+poe build
 ```
 
 To start the backend service, run:
 
 ```bash
-docker run -d -p 8000:8000 prompt-serach-engine
+poe start-backend
+```
+
+To run both use:
+
+```bash
+poe backend
 ```
 
 This command will build the Docker image and start the service.
 
+Note: It takes some time for this service to start.
+
 ### Deployment
 
 The project is integrated with HuggingFace Spaces. The solution is automatically deployed to HuggingFace with every push to the repository.

backend/routes.py

@@ -1,5 +1,6 @@
 import os
 
+from dotenv import load_dotenv
 from fastapi import APIRouter, HTTPException
 from fastapi.responses import HTMLResponse
 
@@ -7,8 +8,6 @@ from backend.models import QueryRequest, QueryResponse, SimilarPrompt
 from src.prompt_loader import PromptLoader
 from src.search_engine import PromptSearchEngine
 
-from dotenv import load_dotenv
-
 # Load environment variables from .env file
 load_dotenv()
 
@@ -82,7 +81,7 @@ async def home_page() -> HTMLResponse:
                 <h1>Prompt Search Engine API</h1>
                 <p>Use this API to find similar prompts based on a query.</p>
                 <h2>POST /most_similar</h2>
-                <p><strong>Request:</strong> <code>{"query": "string", "n": 5}</code></p>
+                <p><strong>Request:</strong> <code>{"query": "string", "n": 1}</code></p>
                 <p><strong>Response:</strong> <code>{"similar_prompts": [{"score": 0.95, "prompt": "Example prompt 1"}]}</code></p>
             </div>
         </body>

frontend/app_ui.py

@@ -2,7 +2,6 @@ import os
 
 import requests
 import streamlit as st
-
 from dotenv import load_dotenv
 
 # Load environment variables from .env file
@@ -34,7 +33,7 @@ def get_similar_prompts(query: str, n: int) -> dict:
         return response.json()
     except requests.RequestException as e:
         st.error(f"Error: {e}")
-        return None
+        return {}
 
 
 def get_color(score: float) -> str:

poe/common-tasks.toml

@@ -26,7 +26,7 @@ sequence = ["style-isort", "style-black"]
 
 [tool.poe.tasks.types]
 help = "Run the type checker"
-cmd  = "mypy . --ignore-missing-imports --check-untyped-defs --install-types --non-interactive"
+cmd  = "mypy . --ignore-missing-imports --check-untyped-defs --install-types --non-interactive --explicit-package-bases"
 
 [tool.poe.tasks.lint]
 help = "Evaluate ruff rules"
@@ -53,4 +53,16 @@ sequence = ["style", "types", "lint", "clean"]
 
 [tool.poe.tasks.frontend]
 help = "Start the UI"
-cmd  = "streamlit run ./frontend/app_ui.py"
+cmd  = "streamlit run ./frontend/app_ui.py"
+
+[tool.poe.tasks.build]
+help = "Build the Docker image"
+cmd  = "docker build -t prompt-search-engine ."
+
+[tool.poe.tasks.start-backend]
+help = "Start the backend"
+cmd  = "docker run -d -p 8000:8000 prompt-search-engine"
+
+[tool.poe.tasks.backend]
+help = "Start the backend"
+sequence = ["build", "start-backend"]

run.py

@@ -3,10 +3,10 @@ import uvicorn
 
 def run_fastapi_app():
     uvicorn.run(
-        "backend.main:app",  # Module name and app instance
+        "backend.main:app",
         host="0.0.0.0",
         port=8000,
-        reload=True,  # Enable auto-reload for development
+        reload=True,
     )
 
 

tests/test_load_data.py

@@ -1,8 +1,7 @@
 import unittest
-from unittest.mock import patch, MagicMock
-from src.prompt_loader import (
-    PromptLoader,
-)
+from unittest.mock import MagicMock, patch
+
+from src.prompt_loader import PromptLoader
 
 
 class TestPromptLoader(unittest.TestCase):

tests/test_similar_prompts.py

@@ -1,8 +1,8 @@
 import unittest
-from unittest.mock import patch, Mock
+from unittest.mock import Mock, patch
+
 import requests
 
-# Assuming the function to be tested is in a module named `frontend.app_ui`
 from frontend.app_ui import get_similar_prompts
 
 
@@ -32,7 +32,8 @@ class TestGetSimilarPrompts(unittest.TestCase):
         result = get_similar_prompts("test query", 3)
 
         # Assertions
-        self.assertIsNone(result)
+        self.assertIsInstance(result, dict)
+        self.assertEqual(len(result), 0)
 
 
 if __name__ == "__main__":