File tree Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -21,9 +21,13 @@ Can be installed via `pip`: `pip install codeflare-sdk`
2121
2222### Prerequisites
2323
24- We recommend using Python 3.9 for development.
24+ We recommend using Python 3.9 for development, along with Poetry.
25+ Create a Poetry virtual environment with the required Python version 3.9, and run all commands within this environment.
26+
27+ - run: ` poetry shell `
2528
2629#### Install dependencies:
30+
2731 - run: ` poetry install `
2832
2933This will install standard requirements as specified in the poetry.lock file. Test and docs dependencies are optional.
@@ -47,13 +51,13 @@ To build the codeflare-sdk pre-commit image run `podman build -f .github/build/C
4751### Testing
4852
4953- To install codeflare-sdk in editable mode, run ` pip install -e . ` from the repo root.
50- - To run the unit tests, run ` poetry run pytest -v tests/unit_test.py`
54+ - To run the unit tests, run ` pytest -v tests/unit_test.py `
5155- Any new test functions/scripts can be added into the ` tests ` folder
5256- NOTE: Functional tests coming soon, will live in ` tests/func_test.py `
5357
5458#### Code Coverage
5559
56- - Run tests with the following command: ` poetry run coverage run -m --source=src pytest tests/unit_test.py`
60+ - Run tests with the following command: ` coverage run -m --source=src pytest tests/unit_test.py `
5761- To then view a code coverage report w/ missing lines, run ` coverage report -m `
5862
5963### Code Formatting
You can’t perform that action at this time.
0 commit comments