diff --git a/README.md b/README.md index a5d8aeb053304f429bef85b703914df8898ef8c2..01e90eb4012513e9637046724dec51d7ec739e8e 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,6 @@ TODO: Decide on whether to use pip freeze or manage requirements.txt manually. R ```sh (venv)$ pip install "fastapi[all]" (and others) -(venv)$ pip freeze > requirements.txt ``` NB! `fastapi[all]` includes a lot of things, in order to get started quickly. Should consider importing only the relevant packages later on. @@ -58,5 +57,22 @@ pip install -r models.txt ### Run application locally ```sh -(venv)$ uvicorn src.main:app --reload +(venv)$ uvicorn app.main:app --reload ``` + +## Troubleshooting for Mac users +2023-02-14: When running the app locally on a Mac, this error occured when calling the /models endpoint: + +``` +unittest.case.SkipTest: No module named '_lzma' +``` + +Instructions to fix this are as follows : +``` +$ brew install xz +$ pyenv uninstall 3.10.6 +$ pyenv install 3.10.6 +``` + + +