Setup troubleshooting and poetry package additions (bcgov#3111)

- Add some troubleshooting to api README - Add greenlet to poetry managed dependencies
vanislekahuna · Sep 7, 2023 · 7c4ae2b · 7c4ae2b
1 parent c2a85a3
commit 7c4ae2b
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/api/README.md b/api/README.md
@@ -12,7 +12,6 @@ You will need an environment file. See: `.env.example`. Contact current maintain
   - then activate the virtual environment with `poetry shell`
   - then run:
     - python -m pip install gdal==$(gdal-config --version)
-    - pip install greenlet
   - Follow [vsc setup steps](../setup/VSC.md)
 - Manual (linux): See [manual setup](../docs/MANUAL_SETUP.md).
   Note: you may want to alias `python3` as `python` in your profile
@@ -43,3 +42,20 @@ Or run continuously with pytest-testmon and pytest-watch (`ptw --runner "pytest
 ```bash
 make test-watch
 ```
+
+### Troubleshooting
+
+**Poetry can't install rpy2**
+Error: `ld: library not found for -lpcre2-8`
+
+pcre2 should be installed after running [mac.sh](../setup/mac.sh). This can be verified by running
+
+```bash
+brew list pcre2
+```
+
+This issue can be resolved by running the following command before `poetry_setup.sh`: (adjust path as necessary)
+
+```bash
+export LIBRARY_PATH="/opt/homebrew/Cellar/pcre2/10.42/lib/:$LIBRARY_PATH"
+```
diff --git a/api/poetry.lock b/api/poetry.lock
diff --git a/api/pyproject.toml b/api/pyproject.toml
@@ -42,6 +42,7 @@ rasterio = "^1.3.2"
 scikit-learn = "^1.1.3"
 httpx = "^0.24.0"
 orjson = "^3.9.0"
+greenlet = "^2.0.2"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.1"