v2.5.0a12

Author: ashpreetbedi

.dockerignore

@@ -2,9 +2,6 @@
 
 docs
 .git
-config.json
-Pipfile
-Pipfile.lock
 
 # Cache
 .mypy_cache
@@ -26,8 +23,5 @@ Pipfile.lock
 .venv
 venv*
 aienv*
-apienv*
-appenv*
-llmenv*
 
 .ipynb_checkpoints

Dockerfile

@@ -10,15 +10,21 @@ RUN groupadd -g 61000 ${USER} \
 
 WORKDIR ${APP_DIR}
 
-# Copy requirements and install
-COPY requirements.txt pyproject.toml ./
+# Copy requirements.txt
+COPY requirements.txt ./
+
+# Install requirements
 RUN --mount=type=cache,target=/root/.cache/uv \
     uv pip sync requirements.txt --system
 
 # Copy project files
 COPY . .
 
-COPY scripts /scripts
+# Set permissions for the /app directory
+RUN chown -R ${USER}:${USER} ${APP_DIR}
+
+# Switch to non-root user
 USER ${USER}
-ENTRYPOINT ["/scripts/entrypoint.sh"]
+
+ENTRYPOINT ["/app/scripts/entrypoint.sh"]
 CMD ["chill"]

README.md

@@ -2,47 +2,41 @@
 
 This repo contains the code for running phidata demo-agents in 2 environments:
 
-1. `dev`: A development environment running locally on docker
-2. `prd`: A production environment running on AWS ECS
+1. **dev**: A development environment running locally on docker
+2. **prd**: A production environment running on AWS ECS
 
 ## Setup Workspace
 
 1. Clone the git repo
 
 > from the `demo-agents` dir:
 
-2. Create + activate a virtual env:
+2. Install workspace and activate the virtual env:
 
 ```sh
-python3 -m venv aienv
-source aienv/bin/activate
+./scripts/install.sh
+source .venv/bin/activate
 ```
 
-3. Install `phidata`:
-
-```sh
-pip install phidata
-```
-
-4. Setup workspace:
+3. Setup workspace:
 
 ```sh
 phi ws setup
 ```
 
-5. Copy `workspace/example_secrets` to `workspace/secrets`:
+4. Copy `workspace/example_secrets` to `workspace/secrets`:
 
 ```sh
 cp -r workspace/example_secrets workspace/secrets
 ```
 
-6. Optional: Create `.env` file:
+5. Optional: Create `.env` file:
 
 ```sh
 cp example.env .env
 ```
 
-## Run Api locally
+## Run Demo Agents locally
 
 1. Install [docker desktop](https://www.docker.com/products/docker-desktop)
 
@@ -62,7 +56,7 @@ export OPENAI_API_KEY=sk-***
 phi ws up
 ```
 
-Open [localhost:8000/docs](http://localhost:8000/docs) to view the FastApi docs.
+Open [localhost:8000/docs](http://localhost:8000/docs) to view the demo agents api.
 
 4. Stop the workspace using:
 

db/README.md

@@ -1,41 +1,77 @@
-## Running database migrations
+## Managing database migrations
 
-Steps to migrate the database using alembic:
+This guide outlines the steps to manage database migrations for your workspace.
 
-1. Add/update SqlAlchemy tables in the `db/tables` directory.
-2. Import the SqlAlchemy class in the `db/tables/__init__.py` file.
-3. Create a database revision using: `alembic -c db/alembic.ini revision --autogenerate -m "Revision Name"`
-4. Migrate database using: `alembic -c db/alembic.ini upgrade head`
+## Table of Contents
 
-> Note: Set Env Var `MIGRATE_DB = True` to run the database migration in the entrypoint script at container startup.
+- [Prerequisites](#prerequisites)
+- [Running Migrations](#running-migrations)
+  - [Create a Database Revision](#create-a-database-revision)
+  - [Migrate the Database](#migrate-the-database)
+- [Environment-specific Instructions](#environment-specific-instructions)
+  - [Development Environment](#development-environment)
+  - [Production Environment](#production-environment)
+- [Creating the Migrations Directory](#creating-the-migrations-directory)
+- [Additional Resources](#additional-resources)
 
-Checkout the docs on [adding database tables](https://docs.phidata.com/day-2/database-tables).
+---
+
+## Prerequisites
+
+1. **Update Tables**: To run a migration, first we need to add or update SQLAlchemy tables in the `db/tables` directory.
+2. **Import Classes**: Ensure that the SQLAlchemy table classes are imported in `db/tables/__init__.py`.
+
+## Running Migrations
+
+### Create a Database Revision
+
+After you have added or updated your table, create a new database revision using:
+
+```bash
+alembic -c db/alembic.ini revision --autogenerate -m "Your Revision Message"
+```
+
+> **Note:** Replace `"Your Revision Message"` with a meaningful description of the changes.
+
+### Migrate the Database by applying the revision
+
+Run the migration to update the database schema:
+
+```bash
+alembic -c db/alembic.ini upgrade head
+```
+
+## Environment-specific Instructions
 
-## Creat a database revision using alembic
+Let's explore the migration process for both development and production environments.
 
-Run the alembic command to create a database migration in the dev container:
+### Development Environment
+
+**Create Revision and Migrate:**
 
 ```bash
-docker exec -it ai-api-dev alembic -c db/alembic.ini revision --autogenerate -m "Initialize DB"
+docker exec -it demo-agents-api alembic -c db/alembic.ini revision --autogenerate -m "Your Revision Message"
+docker exec -it demo-agents-api alembic -c db/alembic.ini upgrade head
 ```
 
-## Migrate development database
+### Production Environment
+
+#### Option 1: Automatic Migration at Startup
 
-Run the alembic command to migrate the dev database:
+Set the environment variable `MIGRATE_DB=True` to run migrations automatically when the container starts. This executes:
 
 ```bash
-docker exec -it ai-api-dev alembic -c db/alembic.ini upgrade head
+alembic -c db/alembic.ini upgrade head
 ```
 
-## Migrate production database
+#### Option 2: Manual Migration via SSH
 
-1. Recommended: Set Env Var `MIGRATE_DB = True` which runs `alembic -c db/alembic.ini upgrade head` from the entrypoint script at container startup.
-2. **OR** you can SSH into the production container to run the migration manually
+SSH into the production container and run the migration manually:
 
 ```bash
-ECS_CLUSTER=ai-api-prd-cluster
-TASK_ARN=$(aws ecs list-tasks --cluster ai-api-prd-cluster --query "taskArns[0]" --output text)
-CONTAINER_NAME=ai-api-prd
+ECS_CLUSTER=demo-agents-cluster
+TASK_ARN=$(aws ecs list-tasks --cluster $ECS_CLUSTER --query "taskArns[0]" --output text)
+CONTAINER_NAME=demo-agents-api
 
 aws ecs execute-command --cluster $ECS_CLUSTER \
     --task $TASK_ARN \
@@ -44,21 +80,35 @@ aws ecs execute-command --cluster $ECS_CLUSTER \
     --command "alembic -c db/alembic.ini upgrade head"
 ```
 
----
+## Creating the Migrations Directory
 
-## How to create the migrations directory
+> **Note:** These steps have already been completed and are included here for reference.
 
-> This has already been run and is described here for completeness
+1. **Access the Development Container:**
 
-```bash
-docker exec -it ai-api-dev zsh
+    ```bash
+    docker exec -it demo-agents-api zsh
+    ```
 
-cd db
-alembic init migrations
-```
+2. **Initialize Alembic Migrations:**
+
+    ```bash
+    cd db
+    alembic init migrations
+    ```
+
+3. **Post-Initialization Steps:**
+
+    - **Update `alembic.ini`:**
+        - Set `script_location = db/migrations`.
+    - **Update `migrations/env.py`:**
+        - Modify according to the [Alembic Autogenerate Documentation](https://alembic.sqlalchemy.org/en/latest/autogenerate.html).
+
+## Additional Resources
+
+- **Adding Database Tables:** Refer to the [Phidata documentation](https://docs.phidata.com/day-2/database-tables) for detailed instructions on adding database tables.
+- **Environment Variable Note:** Setting `MIGRATE_DB=True` ensures that the migration command runs from the entrypoint script when the container starts.
+
+---
 
-- After running the above commands, the `db/migrations` directory should be created.
-- Update `alembic.ini`
-  - set `script_location = db/migrations`
-  - uncomment `black` hook in `[post_write_hooks]`
-- Update `migrations/env.py` file following [this link](https://alembic.sqlalchemy.org/en/latest/autogenerate.html)
+Feel free to customize this README further to suit your project's needs.

db/session.py

@@ -1,25 +1,27 @@
+from typing import Generator
+
 from sqlalchemy.engine import Engine, create_engine
 from sqlalchemy.orm import Session, sessionmaker
 
 from db.settings import db_settings
 
 # Create SQLAlchemy Engine using a database URL
-db_url = db_settings.get_db_url()
+db_url: str = db_settings.get_db_url()
 db_engine: Engine = create_engine(db_url, pool_pre_ping=True)
 
 # Create a SessionLocal class
 # https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-sessionlocal-class
 SessionLocal: sessionmaker[Session] = sessionmaker(autocommit=False, autoflush=False, bind=db_engine)
 
 
-def get_db():
+def get_db() -> Generator[Session, None, None]:
     """
     Dependency to get a database session.
 
-    https://fastapi.tiangolo.com/tutorial/sql-databases/#create-a-dependency
+    Yields:
+        Session: An SQLAlchemy database session.
     """
-
-    db = SessionLocal()
+    db: Session = SessionLocal()
     try:
         yield db
     finally:

pyproject.toml

@@ -14,7 +14,7 @@ dependencies = [
   "mypy",
   "openai",
   "pgvector",
-  "phidata[aws]==2.5.0a11",
+  "phidata[aws]==2.5.0a12",
   "psycopg[binary]",
   "pypdf",
   "pytest",

requirements.txt

@@ -1,11 +1,11 @@
 # This file was autogenerated by uv via the following command:
-#    ./scripts/generate_requirements.sh
+#    ./scripts/generate_requirements.sh upgrade
 alembic==1.13.3
 annotated-types==0.7.0
 anyio==4.6.0
 beautifulsoup4==4.12.3
-boto3==1.35.37
-botocore==1.35.37
+boto3==1.35.38
+botocore==1.35.38
 certifi==2024.8.30
 charset-normalizer==3.4.0
 click==8.1.7
@@ -44,7 +44,7 @@ packaging==24.1
 pandas==2.2.3
 peewee==3.17.6
 pgvector==0.3.5
-phidata==2.5.0a11
+phidata==2.5.0a12
 platformdirs==4.3.6
 pluggy==1.5.0
 psycopg==3.1.19

scripts/entrypoint.sh

@@ -27,7 +27,7 @@ if [[ "$WAIT_FOR_REDIS" = true || "$WAIT_FOR_REDIS" = True ]]; then
 fi
 
 ############################################################################
-# Install dependencies
+# Install requirements
 ############################################################################
 
 if [[ "$INSTALL_REQUIREMENTS" = true || "$INSTALL_REQUIREMENTS" = True ]]; then

utils/dttm.py

@@ -5,5 +5,5 @@ def current_utc() -> datetime:
     return datetime.now(timezone.utc)
 
 
-def current_utc_str() -> str:
-    return current_utc().strftime("%Y-%m-%dT%H:%M:%S")
+def current_utc_str(format: str = "%Y-%m-%dT%H:%M:%S.%fZ") -> str:
+    return current_utc().strftime(format)

utils/log.py

@@ -1,10 +1,21 @@
 import logging
+from typing import Optional
 
 
-def build_logger(logger_name: str) -> logging.Logger:
+def build_logger(
+    logger_name: str,
+    log_level: int = logging.INFO,
+    show_time: bool = False,
+    rich_tracebacks: bool = False,
+    tracebacks_show_locals: bool = False
+) -> logging.Logger:
     from rich.logging import RichHandler
 
-    rich_handler = RichHandler(show_time=False, rich_tracebacks=False, tracebacks_show_locals=False)
+    rich_handler = RichHandler(
+        show_time=show_time,
+        rich_tracebacks=rich_tracebacks,
+        tracebacks_show_locals=tracebacks_show_locals
+    )
     rich_handler.setFormatter(
         logging.Formatter(
             fmt="%(message)s",
@@ -14,9 +25,14 @@ def build_logger(logger_name: str) -> logging.Logger:
 
     _logger = logging.getLogger(logger_name)
     _logger.addHandler(rich_handler)
-    _logger.setLevel(logging.INFO)
+    _logger.setLevel(log_level)
     _logger.propagate = False
     return _logger
 
 
-logger: logging.Logger = build_logger("ai-api")
+# Default logger instance
+logger: logging.Logger = build_logger("demo-agents")
+
+# Function to get or create a logger
+def get_logger(name: Optional[str] = None) -> logging.Logger:
+    return logger if name is None else build_logger(name)