Skip to content

Commit ede676d

Browse files
committed
updating READNE.md to use poetry shell
1 parent ba4cf79 commit ede676d

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,13 @@ Can be installed via `pip`: `pip install codeflare-sdk`
2020

2121
### Prerequisites
2222

23-
We recommend using Python 3.9 for development.
23+
We recommend using Python 3.9 for development, along with Poetry.
24+
Create a Poetry virtual environment with the required Python version 3.9, and run all commands within this environment.
25+
26+
- run: `poetry shell`
2427

2528
#### Install dependencies:
29+
2630
- run: `poetry install`
2731

2832
This will install standard requirements as specified in the poetry.lock file. Test and docs dependencies are optional.
@@ -46,13 +50,13 @@ To build the codeflare-sdk pre-commit image run `podman build -f .github/build/C
4650
### Testing
4751

4852
- To install codeflare-sdk in editable mode, run `pip install -e .` from the repo root.
49-
- To run the unit tests, run `poetry run pytest -v tests/unit_test.py`
53+
- To run the unit tests, run `pytest -v tests/unit_test.py`
5054
- Any new test functions/scripts can be added into the `tests` folder
5155
- NOTE: Functional tests coming soon, will live in `tests/func_test.py`
5256

5357
#### Code Coverage
5458

55-
- Run tests with the following command: `poetry run coverage run -m --source=src pytest tests/unit_test.py`
59+
- Run tests with the following command: `coverage run -m --source=src pytest tests/unit_test.py`
5660
- To then view a code coverage report w/ missing lines, run `coverage report -m`
5761

5862
### Code Formatting

0 commit comments

Comments
 (0)