diff --git a/.github/workflows/coverage-badge.yaml b/.github/workflows/coverage-badge.yaml index 625576fca..692998afd 100644 --- a/.github/workflows/coverage-badge.yaml +++ b/.github/workflows/coverage-badge.yaml @@ -20,10 +20,8 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - pip install pytest==6.2.4 - pip install pytest-mock==3.6.1 - pip install coverage - if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + pip install poetry + poetry install --with test - name: Generate coverage report run: | coverage run -m --source=src pytest -v tests/unit_test.py diff --git a/README.md b/README.md index 0e5274d8a..990311b55 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ This will install standard requirements as specified in the poetry.lock file. Te To include test dependencies run: `poetry install --with test` -To include docs dependencies run: `poetry instal --with docs` +To include docs dependencies run: `poetry install --with docs` To include test and docs dependencies run: `poetry install --with test,docs` @@ -38,6 +38,8 @@ If you require a requirements.txt file you can run: We use pre-commit to make sure the code is consistently formatted. To make sure that pre-commit is run every time you commit changes, simply run `pre-commit install` +To build the codeflare-sdk pre-commit image run `podman build -f .github/build/Containerfile .` from the root directory. + ### Testing - To install codeflare-sdk in editable mode, run `pip install -e .` from the repo root.