Skip to content

Commit c30436f

Browse files
committed
update: readme run commands
1 parent bfbaa0a commit c30436f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,25 @@ PyTest Integration with BrowserStack using SDK.
99
## Setup
1010

1111
* Clone the repo with `git clone -b sdk https://github.com/browserstack/pytest-browserstack.git`
12+
* It is recommended to use a virtual environment to install dependencies. To create a virtual environment:
13+
```
14+
python3 -m venv env
15+
source env/bin/activate # on Mac
16+
env\Scripts\activate # on Windows
17+
```
1218
* Install dependencies `pip install -r requirements.txt`
1319
* To run your automated tests using BrowserStack, you must provide a valid username and access key. This can be done either by providing your username and access key in the `browserstack.yml` configuration file, or by setting the `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` environment variables.
1420

1521
## Run sample test in parallel:
1622
* To run the sample test across platforms defined in the configuration file run:
1723
```
18-
browserstack-sdk pytest -s tests/test_sample.py
24+
browserstack-sdk pytest -s tests/test.py
1925
```
2026

2127
## Run a sample local test:
2228
* To run the sample local test across platforms defined in the configuration file, you just need to set `browserstackLocal` key as true in the `browserstack.yml` file and run:
2329
```
24-
browserstack-sdk pytest -s tests/test_local.py
30+
browserstack-sdk pytest -s tests/local-test.py
2531
```
2632

2733
## Notes

0 commit comments

Comments
 (0)