feat: updating deps, makefile consistency, formatting, using port 8080

Author: wjohnsto

.env.example

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

Makefile

@@ -1,30 +1,49 @@
-install:
+MAKEFLAGS += --no-print-directory
+
+## ---------------------------------------------------------------------------
+## | The purpose of this Makefile is to provide all the functionality needed |
+## | to install, develop, build, and run this app.                           |
+## ---------------------------------------------------------------------------
+
+help:              ## Show this help
+	@sed -ne '/@sed/!s/## //p' $(MAKEFILE_LIST)
+
+install:           ## Install all dependencies
 	@uv sync --all-extras
 
-dev: install
-	@fastapi dev src/app/main.py
+dev:               ## Run a dev server and watch files to restart
+	@$(MAKE) install
+	@fastapi dev src/app/main.py --port 8080
 
-serve: install
-	@fastapi run src/app/main.py
+serve:             ## Run a production server
+	@$(MAKE) install
+	@fastapi run src/app/main.py --port 8080
 
-test:
+test:              ## Run tests
 	@pytest -rxP
 
-docker:
-	@docker compose up -d
+docker:            ## Spin down docker containers and then rebuild and run them
+	@docker compose down
+	@docker compose up -d --build
 
-format: install
+format:            ## Format code
+	@$(MAKE) install
 	@ruff check src/app --fix
 	@ruff format src/app
 
-lint: install
+lint:              ## Lint code
+	@$(MAKE) install
+	@$(MAKE) format
 	@mypy src/app
-	@ruff check src/app
-	@ruff format src/app --check
 
-lock: install
+lock:              ## Update lock file
+	@$(MAKE) install
 	@uv lock
 
-clean:
+update:            ## Update dependencies
+	@$(MAKE) install
+	@uv sync --upgrade
+
+clean:             ## Remove build files
 	@rm -rf .venv/ .mypy_cache/ .ruff_cache/ .pytest_cache/
 	@find . -type d -name __pycache__ -exec rm -r {} \+

README.md

@@ -34,7 +34,7 @@ Next, spin up docker containers:
 make docker
 ```
 
-You should have a server running on `http://localhost:<port>` where the port is set in your `.env` file (default is 8000). You can test the following routes:
+You should have a server running on `http://localhost:<port>` where the port is set in your `.env` file (default is 8080). You can test the following routes:
 
 1. `GET /api/todos` - Gets all todos
 2. `GET /api/todos/:id` - Gets a todo by ID
@@ -69,23 +69,7 @@ make dev
 
 ## Other Scripts
 
-Run a production server outside of docker:
-
-```bash
-make serve
-```
-
-Formatting code:
-
-```bash
-make format
-```
-
-Linting:
-
-```bash
-make lint
-```
+Run `make` to see the list of available commands.
 
 ## Connecting to Redis Cloud
 

__test__/Tests.http

@@ -0,0 +1,35 @@
+@Host = http://localhost:8080
+
+### Get All Todos
+GET {{Host}}/api/todos HTTP/1.1
+
+### Search Todos
+
+GET {{Host}}/api/todos/search?status=in progress HTTP/1.1
+
+### Get a single todo
+
+GET {{Host}}/api/todos/1 HTTP/1.1
+
+### Create a todo
+
+POST {{Host}}/api/todos HTTP/1.1
+Content-Type: application/json
+
+{
+    "id": "2",
+    "name": "Laundry"
+}
+
+### Update a todo
+
+PATCH {{Host}}/api/todos/2 HTTP/1.1
+Content-Type: application/json
+
+{
+    "status": "in progress"
+}
+
+### Delete a todo
+
+DELETE {{Host}}/api/todos/2 HTTP/1.1

pyproject.toml

@@ -10,7 +10,7 @@ maintainers = [
 ]
 readme = "README.md"
 license = "MIT"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 keywords = ["python", "fastapi", "redis", "starter", "redis-py"]
 classifiers = [
   "Development Status :: 4 - Beta",
@@ -27,7 +27,7 @@ dependencies = [
 [dependency-groups]
 dev = [
     "pytest>=8.3.4",
-    "pytest-asyncio>=0.24.0",
+    "pytest-asyncio>=0.25.3",
 ]
 
 [project.urls]

src/app/components/todos/router.py

@@ -9,6 +9,7 @@
 
 todos_store: TodoStore | None = None
 
+
 def get_todos() -> TodoStore:
     global todos_store