Skip to content

Commit

Permalink
Merge pull request #4 from joaovitorsilvestre/improve_readme
Browse files Browse the repository at this point in the history
Improve readme
  • Loading branch information
joaovitorsilvestre authored Jan 30, 2024
2 parents 8553474 + 06ac2a5 commit 5761266
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Running tests with `pytest-xdist` with multiple workers, evenly distributing slo
### Example

Consider a test suite with six tests, each taking varying amounts of time to run:
![Test Suite](https://github.com/joaovitorsilvestre/pytest-slow-first/blob/master/docs/assets/test_suite.png?raw=true)
<img src="https://github.com/joaovitorsilvestre/pytest-slow-first/blob/master/docs/assets/test_suite.png?raw=true" alt="Suite with 6 tests and their times" title="Example of test suite" style="width: 60% !important;">

Running this suite with two workers using only `pytest-xdist` might result in uneven distribution:

![Default xdist Distribution](https://github.com/joaovitorsilvestre/pytest-slow-first/blob/master/docs/assets/only_xdist.png?raw=true)
<img src="https://github.com/joaovitorsilvestre/pytest-slow-first/blob/master/docs/assets/only_xdist.png?raw=true" alt="Suite running with xdist" title="Only xdist" style="width: 70% !important;">

However, with `pytest-slow-first`, the same suite will be executed more efficiently and takes less time to finish, as shown below:

![xdist and slow-first Distribution](https://github.com/joaovitorsilvestre/pytest-slow-first/blob/master/docs/assets/xdist_and_slow_first.png?raw=true)
<img src="https://github.com/joaovitorsilvestre/pytest-slow-first/blob/master/docs/assets/xdist_and_slow_first.png?raw=true" alt="Suite with 6 tests running with xdist + slow-first" title="Xdist + slow-first" style="width: 60% !important;">

## Usage

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ def read(fname):

setup(
name='pytest-slow-first',
version='1.0.2',
version='1.0.3',
author='João Vitor Silvestre',
author_email='joao_vitor_silvestre@outlook.com',
maintainer='João Vitor Silvestre',
Expand Down

0 comments on commit 5761266

Please sign in to comment.