File tree 1 file changed +7
-3
lines changed
1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -20,9 +20,13 @@ Can be installed via `pip`: `pip install codeflare-sdk`
20
20
21
21
### Prerequisites
22
22
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 `
24
27
25
28
#### Install dependencies:
29
+
26
30
- run: ` poetry install `
27
31
28
32
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
46
50
### Testing
47
51
48
52
- 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 `
50
54
- Any new test functions/scripts can be added into the ` tests ` folder
51
55
- NOTE: Functional tests coming soon, will live in ` tests/func_test.py `
52
56
53
57
#### Code Coverage
54
58
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 `
56
60
- To then view a code coverage report w/ missing lines, run ` coverage report -m `
57
61
58
62
### Code Formatting
You can’t perform that action at this time.
0 commit comments