Skip to content

Commit b5fef4e

Browse files
authored
Live tests: update README (#37512)
1 parent c05c70b commit b5fef4e

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

airbyte-ci/connectors/live-tests/README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,16 @@ This project contains utilities for running connector tests against live data.
1010

1111
## Install
1212
```bash
13-
# From tools/connectors/live-tests
14-
pipx install .
15-
# To install in editable mode for development
16-
pipx install . --force --editable
13+
# From airbyte-ci/connectors/live-tests
14+
poetry install
1715
```
1816

1917
## Commands
2018

2119
### `debug`
2220

2321
```
24-
Usage: live-tests debug [OPTIONS] {check|discover|read|read-with-state|spec}
22+
Usage: poetry run live-tests debug [OPTIONS] {check|discover|read|read-with-state|spec}
2523
2624
Run a specific command on one or multiple connectors and persists the
2725
outputs to local storage.
@@ -57,7 +55,7 @@ It will write artifacts to an output directory:
5755
Let's run `debug` to check the output of `read` on two different versions of the same connector:
5856

5957
```bash
60-
live-tests debug read \
58+
poetry run live-tests debug read \
6159
--connection-id=d3bd39cd-6fec-4691-a661-d52c466d8554
6260
--connector-image=airbyte/source-pokeapi:dev \
6361
--connector-image=airbyte/source-pokeapi:latest \
@@ -94,7 +92,7 @@ live_tests_debug_reports
9492
You can also run the `debug` command on a live connection by passing the `--connection-id` option:
9593

9694
```bash
97-
live-tests debug read \
95+
poetry run live-tests debug read \
9896
--connector-image=airbyte/source-pokeapi:dev \
9997
--connector-image=airbyte/source-pokeapi:latest \
10098
--connection-id=<CONNECTION-ID>
@@ -119,7 +117,8 @@ You can run the existing test suites with the following command:
119117
#### With local connection objects (`config.json`, `catalog.json`, `state.json`)
120118
```bash
121119
poetry run pytest src/live_tests/regression_tests \
122-
--connector-image=airbyte/source-faker \
120+
--connector-image=airbyte/source-faker \
121+
--connection-id=<CONNECTION-ID> \
123122
--config-path=<path-to-config-path> \
124123
--catalog-path=<path-to-catalog-path> \
125124
--target-version=dev \

0 commit comments

Comments
 (0)