Skip to content

Commit 924e0fa

Browse files
author
Gaurav Singh
committed
Updated readme
1 parent d4482fa commit 924e0fa

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,4 +128,5 @@ dmypy.json
128128
# Pyre type checker
129129
.pyre/
130130
.idea
131+
.vscode/
131132
data/

README.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,17 @@
22

33
## Purpose
44

5-
Code for TAU (Test automation university) course on building an API framework with Python. Once ready this would be
6-
published at [Test automation university](https://testautomationu.applitools.com/), You can also find a series of blogs
7-
that I'm writing for this course on my blog [https://automationhacks.io/](https://automationhacks.io/tags/)
8-
under `Python` tag. However, the video courses are going to have much more context and in depth discussions
5+
Code for TAU (Test automation university) course on building an API framework with Python. Once
6+
ready this would be published at
7+
[Test automation university](https://testautomationu.applitools.com/), You can also find a series of
8+
blogs that I'm writing for this course on my blog
9+
[https://automationhacks.io/](https://automationhacks.io/tags/) under `Python` tag. However, the
10+
video courses are going to have much more context and in depth discussions
911

1012
## Setup
1113

12-
Ensure you
13-
have [pipenv already installed](https://automationhacks.io/2020/07/12/how-to-manage-your-python-virtualenvs-with-pipenv/):
14+
Ensure you have
15+
[pipenv already installed](https://automationhacks.io/2020/07/12/how-to-manage-your-python-virtualenvs-with-pipenv/):
1416

1517
```zsh
1618
# Activate virtualenv
@@ -21,8 +23,8 @@ pipenv install
2123

2224
## How to navigate
2325

24-
Each chapter has its own dedicated branch in `/example/<chapter_no>_<topic>` format. For
25-
e.g. `example/01_setup_python_dependencies`
26+
Each chapter has its own dedicated branch in `/example/<chapter_no>_<topic>` format. For e.g.
27+
`example/01_setup_python_dependencies`
2628

2729
You can either use your IDE or terminal to switch to that branch and see the last updated commit.
2830

@@ -35,32 +37,39 @@ git checkout <sha>
3537

3638
## Application under test
3739

38-
This automated test suite covers features of `people-api`, Please refer the Github
39-
repo [here](https://github.com/automationhacks/people-api).
40+
This automated test suite covers features of `people-api`, Please refer the Github repo
41+
[here](https://github.com/automationhacks/people-api).
4042

41-
Note: These tests expect the `people-api` and `covid-tracker` API to be up. You would find instructions in
42-
the `people-api` repo
43+
Note: These tests expect the `people-api` and `covid-tracker` API to be up. You would find
44+
instructions in the `people-api` repo
4345

4446
## How to run
4547

4648
```zsh
4749
# Setup report portal on docker
4850
# Update rp_uuid in pytest.ini with project token
4951
docker-compose -f docker-compose.yml -p reportportal up -d
52+
5053
# Launch pipenv
5154
pipenv shell
55+
5256
# Install all packages
5357
pipenv install
58+
5459
# Run tests via pytest (single threaded)
5560
python -m pytest
56-
# RUn tests in parallel
61+
62+
# Run tests in parallel
5763
python -m pytest -n auto
64+
65+
# Report results to report portal
66+
python -m pytest -n auto ./tests --reportportal
5867
```
5968

6069
## Discuss?
6170

62-
Feel free to use the [Github discussions](https://github.com/automationhacks/course-api-framework-python/discussions/1)
71+
Feel free to use the
72+
[Github discussions](https://github.com/automationhacks/course-api-framework-python/discussions/1)
6373
in this repo to ✍🏼 your thoughts or even use the disqus comments section on the blogs.
6474

6575
Happy learning!
66-

0 commit comments

Comments
 (0)