Rename folders

Python does not allow using numbers at the start of a module name it seems. Also tidy up comments in the current api files.

Author: badlydrawnrob

building-with-fast-api/01-hello-world/api.py

@@ -10,9 +10,12 @@ Whereas Elm has a central `Model` (generally) to work from and uses modules and
 
 > These are annoying and compared to Elm (where everything just works), not particularly user-friendly. You'd think you could just run commands once you're set up with a `venv` (virtual environment).
 
-1. `uvicorn` command [won't run](https://stackoverflow.com/a/69322150)
+1. Module naming clashes and `venv`:
+    - `uv` commands require calling from the `venv` parent directory
+    - `01` numbers are invalid for module names
+2. `uvicorn` command [won't run](https://stackoverflow.com/a/69322150)
     - Preface it with `uv run` (equivalent to `python -m`)
-2. Using Thonny as an IDE
+3. Using Thonny as an IDE
     - I can get the version of Python running but the other stuff is harder
 
 ## Tools

building-with-fast-api/README.md

@@ -0,0 +1,20 @@
+from fastapi import FastAPI
+
+# ------------------------------------------------------------------------------
+# Hello World!
+# ==============================================================================
+# The most basic route we can make. `app` uses an instance of the `FastAPI` class
+# and we return a dictionary. The problem with using the `FastAPI()` instance is
+# that it can only run ONE route.
+#
+# For multiple routes, use the `APIRouter` class.
+#
+# Running the server
+# ------------------
+# `uv run uvicorn 01-hello-world.api:app --port 8000 --reload` (from parent dir)
+
+app = FastAPI()
+
+@app.get("/")
+async def welcome() -> dict:
+    return { "message": "Hello World" }

building-with-fast-api/chapter_01/api.py

@@ -0,0 +1,25 @@
+from fastapi import FastAPI
+from chapter_02.todo import router
+
+# ------------------------------------------------------------------------------
+# A to do app
+# ==============================================================================
+# Uvicorn cannot use the `APIRouter()` instance directly to serve the application,
+# like we did with `uv run uvicorn api:app --port 8000 --reload`. We've got to
+# add these routes to the `FastAPI()` instance to enable their visibility.
+#
+# Include router
+# --------------
+# `include_router(router, ...)` method is responsible for adding routes defined
+# with `APIRouter` class to the main application's instance.
+#
+# - `app` variable now has an instance of the `FastAPI` class.
+# - `.include_router` is a method of this class
+
+app = FastAPI()
+
+@app.get("/")
+async def welcome() -> dict:
+    return { "message": "Hello Buddy!" }
+
+app.include_router(router) # includes TO DO routes (instance of `APIRouter()`)

building-with-fast-api/01-hello-world/hello.py building-with-fast-api/chapter_01/hello.py

@@ -12,6 +12,7 @@ You can rip a lot of this stuff from the book, but put it in very simple terms.
 - Basic syntax differences
     - `function()` calls and arguments
     - Typing (just a taste)
+    - Python [comments](https://realpython.com/python-comments-guide/)
 - The `app` variable (I guess this holds the state)
 - Models (Elm has one master model)
 - Decorators