Skip to content

Commit 4d9aafb

Browse files
docs: Update README to reflect poe changes
1 parent 983781b commit 4d9aafb

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,11 @@ Style decisions are based on the [Google Python Style Guide](https://google.gith
4747

4848
| Command | Summary | Bash Equivalent |
4949
| ---------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
50-
| `poe test` | Run integration tests with coverage | `PYTHONPATH=src poetry run pytest -vv --import-mode=importlib --cov=src/package_name --cov-fail-under=90 --cov=src/package_name --cov-branch --cov-report term-missing:skip-covered tests/unit tests/integration` |
51-
| `poe test-all` | Run all tests (without coverage) | `PYTHONPATH=src pytest -vv --import-mode=importlib tests` |
50+
| `poe test` | Run application test suites that support coverage | `PYTHONPATH=src poetry run pytest -vv --import-mode=importlib --cov=src/package_name --cov-fail-under=90 --cov=src/package_name --cov-branch --cov-report term-missing:skip-covered tests/unit tests/integration` |
51+
| `poe test-all` | Run all tests (without coverage) | `PYTHONPATH=src pytest -vv --import-mode=importlib` |
5252
| `poe test-e2e` | Run e2e tests only | `PYTHONPATH=src poetry run pytest -vv --import-mode=importlib tests/e2e` |
5353
| `poe test-integration` | Run integration tests only (with coverage) | `PYTHONPATH=src poetry run pytest -vv --import-mode=importlib --cov=src/package_name --cov-fail-under=90 --cov=src/package_name --cov-branch --cov-report term-missing:skip-covered tests/integration` |
54-
| `poe test-unit` | Run unit tests only (with coverage) | `PYTHONPATH=src poetry run pytest -vv --import-mode=importlib --cov=src/package_name --cov-fail-under=90 --cov=src/package_name --cov-branch --cov-report term-missing:skip-covered tests/unit` |
54+
| `poe test-unit` | Run unit tests only (without coverage) | `PYTHONPATH=src poetry run pytest -vv --import-mode=importlib tests/unit` |
5555
| `poe check` | Run all formatting and linting tools against codebase | `poetry run black --check --line-length 100 . && npx --yes prettier@3.0.3 . --no-config --check && poetry run pylint src tests` |
5656
| `poe format` | Run all formatting tools against codebase | `poetry run black --check --line-length 100 . && npx --yes prettier@3.0.3 . --no-config --check` |
5757
| `poe format-black` | Run black against Python source code | `poetry run black --check --line-length 100 .` |
@@ -70,7 +70,7 @@ Running `pytest` with no arguments will:
7070
- Override pytest's historical default import mode to `importlib` which is recommended for new projects (`--import-mode=importlib`)
7171
- Run all available test items in [`./tests/`](./tests)
7272

73-
Tests are grouped by categories into different paths:
73+
Tests are grouped into suites using different path names:
7474

7575
```shell
7676
tests/

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "package-name"
3-
version = "1.4.0"
3+
version = "1.3.0"
44
description = "Package description"
55
license = "MIT"
66
authors = ["Author Name <author.email@example.com>"]

0 commit comments

Comments
 (0)