Initial functionality

Author: kevlened

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Len Boyette
+Copyright (c) 2018-Present Browsertron
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Pipfile

@@ -0,0 +1,20 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+pytest = ">=3.0.0"
+
+[dev-packages]
+pylint = "*"
+twine = ">=1.11.0"
+wheel = ">=0.31.0"
+setuptools = ">=39.0.1"
+
+[requires]
+python_version = "3.6"
+
+[scripts]
+build = "python setup.py sdist bdist_wheel"
+deploy = "twine upload dist/*"

Pipfile.lock

@@ -1,2 +1,57 @@
 # pytest-parallel
 a py.test plugin for parallel and concurrent testing
+
+## What?
+
+This plugin makes it possible to run tests quickly using multiprocessing (parallelism) and multithreading (concurrency).
+
+## Why?
+
+`pytest-xdist` is great to run tests that:
+  1. aren't threadsafe
+  2. perform poorly when multithreaded
+  3. need state isolation
+
+`pytest-parallel` is better for some use cases (like Selenium tests) that:
+  1. can be threadsafe
+  2. can use non-blocking IO for http requests to make it performant
+  3. manage little or no state in the Python environment
+
+Put simply, `pytest-xdist` does parallelism while `pytest-parallel` does parallelism and concurrency.
+
+## Requirements
+
+* Python3 version [3.6+]
+* Unix or Mac for parallelism
+
+## Installation
+
+`pip install pytest-parallel`
+
+## Options
+
+* `workers` (optional) - max workers (aka processes) to start. Can be a **positive integer or `auto`** which uses one worker per core. **Defaults to 1**.
+* `tests-per-worker` (optional) - max concurrent tests per worker. Can be a **positive integer or `auto`** which evenly divides tests among the workers up to 50 concurrent tests. **Defaults to 1**.
+
+## Examples
+
+```bash
+# runs 2 workers with 1 test per worker at a time
+pytest --workers 2
+
+# runs 4 workers (assuming a quad-core machine) with 1 test per worker
+pytest --workers auto
+
+# runs 1 worker with 4 tests at a time
+pytest --tests-per-worker 4
+
+# runs 1 worker with up to 50 tests at a time
+pytest --tests-per-worker auto
+
+# runs 2 workers with up to 50 tests per worker
+pytest --workers 2 --tests-per-worker auto
+```
+
+## License
+
+MIT