Removing poetry virtual env in test container and updating README.md

Author: Fiona-Waters

.github/workflows/unit-tests.yml

@@ -14,14 +14,18 @@ jobs:
       image: quay.io/project-codeflare/codeflare-sdk-precommit:v0.0.3
     steps:
       - uses: actions/checkout@v3
+      - name: Install poetry
+        run: pip install poetry
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.8'
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip3 install poetry
+          poetry config virtualenvs.create false
           poetry lock --no-update
           poetry install --with test
       - name: Test with pytest and check coverage
         run: |
-          poetry run coverage run -m --source=src pytest -v tests/unit_test.py
+          coverage run -m --source=src pytest -v tests/unit_test.py
           coverage=$(coverage report -m | tail -1 | tail -c 4 | head -c 2)
           if (( $coverage < 90 )); then exit 1; else echo "Coverage passed, ${coverage}%"; fi

README.md

@@ -22,14 +22,17 @@ Can be installed via `pip`: `pip install codeflare-sdk`
 ### Prerequisites
 
 We recommend using Python 3.9 for development.
-Install dependencies: `poetry install`
+
+#### Install dependencies:
+  - run: `poetry install`
+
 This will install standard requirements as specified in the poetry.lock file. Test and docs dependencies are optional.
 
-To include test dependencies run: `poetry install --with test`
+- To include test dependencies run: `poetry install --with test`
 
-To include docs dependencies run: `poetry install --with docs`
+- To include docs dependencies run: `poetry install --with docs`
 
-To include test and docs dependencies run: `poetry install --with test,docs`
+- To include test and docs dependencies run: `poetry install --with test,docs`
 
 If you require a requirements.txt file you can run:
 
@@ -44,13 +47,13 @@ To build the codeflare-sdk pre-commit image run `podman build -f .github/build/C
 ### Testing
 
 - To install codeflare-sdk in editable mode, run `pip install -e .` from the repo root.
-- To run the unit tests, run `pytest -v tests/unit_test.py`
+- To run the unit tests, run `poetry run pytest -v tests/unit_test.py`
 - Any new test functions/scripts can be added into the `tests` folder
 - NOTE: Functional tests coming soon, will live in `tests/func_test.py`
 
 #### Code Coverage
 
-- Run tests with the following command: `coverage run -m --source=src pytest tests/unit_test.py`
+- Run tests with the following command: `poetry run coverage run -m --source=src pytest tests/unit_test.py`
 - To then view a code coverage report w/ missing lines, run `coverage report -m`
 
 ### Code Formatting