From 8e9e8e4d66a96212a30ebbffae602758c16271e3 Mon Sep 17 00:00:00 2001 From: Lucas Hicks Date: Fri, 13 Oct 2023 10:11:42 +1000 Subject: [PATCH] Updates some more things --- build/db-handler/README.md | 17 ++++++++++++----- build/db-handler/requirements.txt | 4 ++++ 2 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 build/db-handler/requirements.txt diff --git a/build/db-handler/README.md b/build/db-handler/README.md index 3a31d0a..79223bf 100644 --- a/build/db-handler/README.md +++ b/build/db-handler/README.md @@ -8,12 +8,19 @@ This database handler is a web-based RESTful API microservice which is solely re ### Installation -You need a couple of dependencies if you want to run the uvicorn server locally to serve the API. Run these: +You need a couple of dependencies if you want to run the uvicorn server locally to serve the API. Run these options: -* `pip install fastapi` -* `pip install "uvicorn[standard]"` -* `pip install pymongo` -* `pip install pydantic` +1. Install using conda environment + +For convinience, a conda environment has been created so that all project dependencies can be installed using as few commands as possible. See more on this option [here](https://github.com/lucashicks1/lambda-deco3801/blob/main/build/vision/README.md#dependencies) + +2. Install with `requirements.txt`: + +`pip install -r requirements.txt` + +3. Install all dependencies individually: + +`pip install fastapi pymongo pydantic "uvicorn[standard]"` *Note: A python environment with every project dependency is available for use, so this step could be skipped if the other environment is set up.* diff --git a/build/db-handler/requirements.txt b/build/db-handler/requirements.txt new file mode 100644 index 0000000..469fcab --- /dev/null +++ b/build/db-handler/requirements.txt @@ -0,0 +1,4 @@ +fastapi>=0.100.0 +pydantic>=1.9.0 +uvicorn>=0.22.0 +pymongo>=4.4.0 \ No newline at end of file