Skip to content

Commit

Permalink
Updates some more things
Browse files Browse the repository at this point in the history
  • Loading branch information
lucashicks1 committed Oct 13, 2023
1 parent 15f7451 commit 8e9e8e4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
17 changes: 12 additions & 5 deletions build/db-handler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.*

Expand Down
4 changes: 4 additions & 0 deletions build/db-handler/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
fastapi>=0.100.0
pydantic>=1.9.0
uvicorn>=0.22.0
pymongo>=4.4.0

0 comments on commit 8e9e8e4

Please sign in to comment.