setting up makefile and logging

Author: wjohnsto

.env.example

@@ -1,3 +1,4 @@
+LOG_LEVEL=INFO
 PORT=8000
 REDIS_URL="redis://localhost:6379"
 

Makefile

@@ -1,5 +1,5 @@
 install:
-	@uv sync
+	@uv sync --all-extras
 
 dev: install
 	@fastapi dev app/main.py
@@ -23,4 +23,4 @@ lock: install
 	@uv lock
 
 clean:
-	@rm -rf .venv/ .mypy_cache/ .ruff_cache/
+	@rm -rf .venv/ .mypy_cache/ .ruff_cache/

app/logger.py

@@ -0,0 +1,5 @@
+import logging
+import os
+
+logger = logging.getLogger("uvicorn")
+logger.setLevel(os.environ.get("LOG_LEVEL", logging.INFO))

app/main.py

@@ -1,15 +1,37 @@
-from typing import Union
+from dotenv import load_dotenv
+load_dotenv()
+
+import os
+from contextlib import asynccontextmanager
+from typing import Any, AsyncIterator, Never, Union
 
 from fastapi import FastAPI
 
-app = FastAPI()
+import app.redis as redis
+from app.todos import Todos
+
+redis_url = os.environ.get("REDIS_URL", "redis://localhost:6379")
+client = redis.get_client(redis_url)
+todos = Todos(client)
+
+
+@asynccontextmanager
+async def lifespan(_: FastAPI) -> AsyncIterator[Never]:
+    # before
+    await todos.initialize()
+    yield  # type: ignore
+    # after
+    return
+
+
+app = FastAPI(lifespan=lifespan)
 
 
 @app.get("/")
-def read_root():
-    return {"Hello": "World"}
+async def read_root() -> bool:
+    return await todos.have_index()
 
 
 @app.get("/items/{item_id}")
-def read_item(item_id: int, q: Union[str, None] = None):
+def read_item(item_id: int, q: Union[str, None] = None) -> Any:
     return {"item_id": item_id, "q": q}

app/redis.py

@@ -0,0 +1,26 @@
+from typing import Optional
+
+from redis.asyncio import Redis
+from redis.backoff import ExponentialBackoff
+from redis.exceptions import ConnectionError, TimeoutError
+from redis.retry import Retry
+
+from app.logger import logger
+
+client: Optional[Redis] = None
+
+
+def get_client(url: str = "redis://localhost:6379") -> Redis:
+    global client
+
+    if client is None:
+        logger.info(f"Creating redis client for url: {url}")
+        client = Redis.from_url(
+            url,
+            decode_responses=True,
+            retry=Retry(ExponentialBackoff(cap=10, base=1), 25),
+            retry_on_error=[ConnectionError, TimeoutError, ConnectionResetError],
+            health_check_interval=1,
+        )
+
+    return client

app/todos.py

@@ -0,0 +1,56 @@
+from redis.asyncio import Redis
+from redis.commands.search.field import TextField
+from redis.commands.search.indexDefinition import IndexDefinition, IndexType
+from redis.exceptions import ResponseError
+
+from app.logger import logger
+
+TODOS_INDEX = "todos-idx"
+TODOS_PREFIX = "todos:"
+
+
+class Todos:
+    """Stores todos"""
+
+    def __init__(self, redis: Redis):
+        self.redis = redis
+
+    async def initialize(self) -> None:
+        await self.create_index_if_not_exists()
+        return None
+
+    async def have_index(self) -> bool:
+        try:
+            await self.redis.ft(TODOS_INDEX).info()  # type: ignore
+        except ResponseError as e:
+            if "Unknown index name" not in str(e):
+                logger.info(f"Index {TODOS_INDEX} already exists")
+                raise
+
+        return True
+
+    async def create_index_if_not_exists(self) -> None:
+        try:
+            if await self.have_index():
+                return None
+
+            logger.debug(f"Creating index {TODOS_INDEX}")
+
+            schema = (
+                TextField("$.name", as_name="name"),
+                TextField("$.status", as_name="status"),
+            )
+
+            await self.redis.ft(TODOS_INDEX).create_index(  # type: ignore
+                schema,
+                definition=IndexDefinition(  # type: ignore
+                    prefix=[TODOS_PREFIX], index_type=IndexType.JSON
+                ),
+            )
+
+            logger.debug(f"Index {TODOS_INDEX} created successfully")
+        except Exception as e:
+            logger.error(f"Error setting up index {TODOS_INDEX}: {e}")
+            raise
+
+        return None

pyproject.toml

@@ -17,7 +17,11 @@ classifiers = [
   "Intended Audience :: Developers",
   "Programming Language :: Python"
 ]
-dependencies = ["fastapi[standard] (>=0.115.6,<0.116.0)"]
+dependencies = [
+    "fastapi[standard] (>=0.115.6,<0.116.0)",
+    "python-dotenv>=1.0.1",
+    "redis[hiredis]>=5.2.1",
+]
 
 [project.urls]
 Repository = "https://github.com/redis-developer/redis-starter-python.git"
@@ -31,6 +35,7 @@ dev = [
 
 [tool.mypy]
 strict = true
+exclude = ["venv", ".venv"]
 
 [tool.ruff]
 target-version = "py38"