rename to pypi-scout

Dockerfile

@@ -16,8 +16,8 @@ COPY poetry.lock pyproject.toml /code/
 RUN poetry install --no-interaction --no-ansi --no-root --no-dev
 
 # Copy Python code to the Docker image
-COPY pypi_llm /code/pypi_llm/
+COPY pypi_scout /code/pypi_scout/
 
 ENV PYTHONPATH=/code
 
-CMD [ "python", "pypi_llm/foo.py"]
+CMD [ "python", "pypi_scout/foo.py"]

Makefile

@@ -36,7 +36,7 @@ docs: ## Build and serve the documentation
 
 .PHONY: serve
 serve: ## Serve API with uvicorn
-	@poetry run uvicorn pypi_llm.api.main:app --reload
+	@poetry run uvicorn pypi_scout.api.main:app --reload
 
 .PHONY: help
 help:

README.md

@@ -1,19 +1,19 @@
-# pypi-llm
+# pypi-scout
 
 https://drive.google.com/file/d/1huR7-VD3AieBRCcQyRX9MWbPLMb_czjq/view?usp=sharing
 
 # setup
 
 ```
-docker build -t pypi-llm .
+docker build -t pypi-scout .
 ```
 
 ```
 docker run --rm \
   --env-file .env \
   -v $(pwd)/data:/code/data \
-  pypi-llm \
-  python /code/pypi_llm/scripts/1_download_dataset.py
+  pypi-scout \
+  python /code/pypi_scout/scripts/1_download_dataset.py
 ```
 
 ## total

frontend/app/page.tsx

@@ -33,7 +33,7 @@ export default function Home() {
   return (
     <main className="flex flex-col items-center justify-start min-h-screen p-4 space-y-4 bg-gray-100">
       <header className="w-full text-center mb-4">
-        <h1 className="text-4xl font-bold p-2 mt-4">✨PyPi Package Finder</h1>
+        <h1 className="text-4xl font-bold p-2 mt-4">✨PyPi Scout</h1>
         <p className="text-lg text-gray-600">
           Enter your query to search for Python packages
         </p>

notebooks/main.ipynb

@@ -31,11 +31,11 @@
    "source": [
     "import polars as pl\n",
     "from dotenv import load_dotenv\n",
-    "from pypi_llm.config import Config\n",
-    "from pypi_llm.data.description_cleaner import DescriptionCleaner, CLEANING_FAILED\n",
-    "from pypi_llm.data.reader import DataReader\n",
+    "from pypi_scout.config import Config\n",
+    "from pypi_scout.data.description_cleaner import DescriptionCleaner, CLEANING_FAILED\n",
+    "from pypi_scout.data.reader import DataReader\n",
     "from sentence_transformers import SentenceTransformer\n",
-    "from pypi_llm.vector_database import VectorDatabaseInterface\n",
+    "from pypi_scout.vector_database import VectorDatabaseInterface\n",
     "\n",
     "load_dotenv()\n",
     "config = Config()\n",

pypi_llm/api/main.py → pypi_scout/api/main.py

@@ -7,10 +7,10 @@
 from pydantic import BaseModel
 from sentence_transformers import SentenceTransformer
 
-from pypi_llm.config import Config
-from pypi_llm.utils.logging import setup_logging
-from pypi_llm.utils.score_calculator import calculate_score
-from pypi_llm.vector_database import VectorDatabaseInterface
+from pypi_scout.config import Config
+from pypi_scout.utils.logging import setup_logging
+from pypi_scout.utils.score_calculator import calculate_score
+from pypi_scout.vector_database import VectorDatabaseInterface
 
 setup_logging()
 

pypi_llm/scripts/0_setup_pinecone.py → pypi_scout/scripts/0_setup_pinecone.py

@@ -3,8 +3,8 @@
 from dotenv import load_dotenv
 from pinecone import Pinecone, ServerlessSpec
 
-from pypi_llm.config import Config
-from pypi_llm.utils.logging import setup_logging
+from pypi_scout.config import Config
+from pypi_scout.utils.logging import setup_logging
 
 setup_logging()
 

pypi_llm/scripts/1_download_dataset.py → pypi_scout/scripts/1_download_dataset.py

@@ -3,8 +3,8 @@
 import gdown
 from dotenv import load_dotenv
 
-from pypi_llm.config import Config
-from pypi_llm.utils.logging import setup_logging
+from pypi_scout.config import Config
+from pypi_scout.utils.logging import setup_logging
 
 setup_logging()
 

pypi_llm/scripts/2_process_dataset.py → pypi_scout/scripts/2_process_dataset.py

@@ -3,10 +3,10 @@
 import polars as pl
 from dotenv import load_dotenv
 
-from pypi_llm.config import Config
-from pypi_llm.data.description_cleaner import CLEANING_FAILED, DescriptionCleaner
-from pypi_llm.data.reader import DataReader
-from pypi_llm.utils.logging import setup_logging
+from pypi_scout.config import Config
+from pypi_scout.data.description_cleaner import CLEANING_FAILED, DescriptionCleaner
+from pypi_scout.data.reader import DataReader
+from pypi_scout.utils.logging import setup_logging
 
 setup_logging()
 

pypi_llm/scripts/3_upsert_data.py → pypi_scout/scripts/3_upsert_data.py

@@ -4,9 +4,9 @@
 from dotenv import load_dotenv
 from sentence_transformers import SentenceTransformer
 
-from pypi_llm.config import Config
-from pypi_llm.utils.logging import setup_logging
-from pypi_llm.vector_database import VectorDatabaseInterface
+from pypi_scout.config import Config
+from pypi_scout.utils.logging import setup_logging
+from pypi_scout.vector_database import VectorDatabaseInterface
 
 setup_logging()
 

pypi_llm/vector_database/__init__.py → pypi_scout/vector_database/__init__.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
 
-from pypi_llm.vector_database.interface import VectorDatabaseInterface
+from pypi_scout.vector_database.interface import VectorDatabaseInterface
 
 __all__ = ("VectorDatabaseInterface",)

pyproject.toml

@@ -1,13 +1,13 @@
 [tool.poetry]
-name = "pypi_llm"
+name = "pypi_scout"
 version = "0.0.1"
 description = "This is a template repository for Python projects that use Poetry for their dependency management."
 authors = ["Florian Maas <[email protected]>"]
-repository = "https://github.com/fpgmaas/pypi-llm"
-documentation = "https://fpgmaas.github.io/pypi-llm/"
+repository = "https://github.com/fpgmaas/pypi-scout"
+documentation = "https://fpgmaas.github.io/pypi-scout/"
 readme = "README.md"
 packages = [
-  {include = "pypi_llm"}
+  {include = "pypi_scout"}
 ]
 
 [tool.poetry.dependencies]
@@ -44,7 +44,7 @@ requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.mypy]
-files = ["pypi_llm"]
+files = ["pypi_scout"]
 disallow_untyped_defs = "True"
 disallow_any_unimported = "True"
 no_implicit_optional = "True"
@@ -107,7 +107,7 @@ skip_empty = true
 
 [tool.coverage.run]
 branch = true
-source = ["pypi_llm"]
+source = ["pypi_scout"]
 
 
 [tool.ruff.per-file-ignores]