Skip to content

Commit cd026a0

Browse files
committed
making test dependencies optional, and updating readme accordingly
1 parent 132687c commit cd026a0

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,13 @@ Can be installed via `pip`: `pip install codeflare-sdk`
2222

2323
We recommend using Python 3.9 for development.
2424
Install dependencies: `poetry install`
25-
This will install all requirements as specified in the poetry.lock file.
25+
This will install standard requirements as specified in the poetry.lock file. Test and docs dependencies are optional.
26+
27+
To include test dependencies run: `poetry install --with test`
28+
29+
To include docs dependencies run: `poetry instal --with docs`
30+
31+
To include test and docs dependencies run: `poetry install --with test,docs`
2632

2733
If you require a requirements.txt file you can run:
2834

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ optional = true
3636
[tool.poetry.group.docs.dependencies]
3737
pdoc3 = "0.10.0"
3838

39+
[tool.poetry.group.test]
40+
optional = true
41+
3942
[tool.poetry.group.test.dependencies]
4043
pytest = "7.4.0"
4144
coverage = "7.2.7"

0 commit comments

Comments
 (0)