update docs to mention logger

seapagan · seapagan · commit 70adc2f84ce8 · 2025-02-17T12:48:02.000Z
Signed-off-by: Grant Ramsay &lt;seapagan@gmail.com&gt;
diff --git a/BUGS.md b/BUGS.md
diff --git a/README.md b/README.md
@@ -91,6 +91,8 @@ following advantages to starting your own from scratch :
   without needing to send username or password again, and should be done
   automatically by the Front-End.
 - A clean layout to help structure your project.
+- Uses the python logger for info/warning/error logging - tying transparently in
+  to the `uvicorn` logger.
 - **A command-line admin tool**. This allows to configure the project metadata
   very easily, add users (and make admin), and run a development server. This
   can easily be modified to add your own functionality (for example bulk add
diff --git a/TODO.md b/TODO.md
@@ -30,13 +30,12 @@
 - add pagination to the user list endpoint. Implement this in a way that is
   generic and can be used for other custom endpoints too. The library
   'fastapi-pagination' is really good and performant.
-- remove all the `print` statements and replace with proper logging. Hook into
-  the `uvicorn` logger for this, and offer alternative if uvicorn is not being
-  used for some reason.
+- use an alternative loggier if uvicorn is not being used for some reason.
 
 ## Bugs/Annoyances
 
-See [BUGS.md](BUGS.md) for a list of known bugs and annoyances.
+- If a user is deleted while logged in, the API returns a 500 (Internal Server
+   Error).
 
 ## Auth
 
diff --git a/docs/index.md b/docs/index.md
@@ -51,6 +51,8 @@ following advantages to starting your own from scratch :
   automatically by the Front-End.
 - Full test coverage using `Pytest`.
 - A clean layout to help structure your project.
+- Uses the python logger for info/warning/error logging - tying transparently in
+  to the `uvicorn` logger.
 - **A command-line admin tool**. This allows to configure the project metadata
   very easily, add users (and make admin), and run a development server. This
   can easily be modified to add your own functionality (for example bulk add
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -64,15 +64,15 @@ mdurl==0.1.2
 mergedeep==1.3.4
 mkdoc==0.1
 mkdocs==1.6.1
-mkdocs-autorefs==1.3.0
+mkdocs-autorefs==1.3.1
 mkdocs-get-deps==0.2.0
 mkdocs-git-revision-date-localized-plugin==1.3.0
 mkdocs-latest-git-tag-plugin==0.1.2
 mkdocs-material==9.5.50
 mkdocs-material-extensions==1.3.1
 mkdocs-minify-plugin==0.8.0
 mkdocs-swagger-ui-tag==0.6.11
-mkdocstrings==0.27.0
+mkdocstrings==0.28.1
 mkdocstrings-python==1.13.0
 mock==5.1.0
 mypy==1.14.1
diff --git a/uv.lock b/uv.lock
