DESCRIPTION.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. =================
  2. pytest-concurrent
  3. =================
  4. .. image:: https://travis-ci.org/reverbc/pytest-concurrent.svg?branch=master
  5. :target: https://travis-ci.org/reverbc/pytest-concurrent
  6. :alt: See Build Status on Travis CI
  7. .. image:: https://ci.appveyor.com/api/projects/status/github/reverbc/pytest-concurrent?branch=master
  8. :target: https://ci.appveyor.com/project/reverbc/pytest-concurrent/branch/master
  9. :alt: See Build Status on AppVeyor
  10. Concurrently execute pytest testing with `multi-thread`, `multi-process` and `gevent`
  11. ----
  12. This `Pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `Cookiecutter-pytest-plugin`_ template.
  13. Features
  14. --------
  15. * Testing concurrently with pytest, using one of the three modes
  16. - Multiprocess (--concmode=mproc)
  17. - Multithread (--concmode=mthread)
  18. - Asynchronous Network with gevent (--concmode=asyncnet)
  19. * The ability to designate the amount of work to be used for testing
  20. * The ability to put your tests into separate groups
  21. Requirements
  22. ------------
  23. * Python version [2.7 +]
  24. * Python3 version [3.3 +]
  25. * Make sure you have the latest version of pytest installed for your environment
  26. Installation
  27. ------------
  28. You can install "pytest-concurrent" via `pip`_ from `PyPI`_::
  29. $ pip install pytest-concurrent
  30. Usage
  31. -----
  32. * Use this plugin by running pytest normally and use --concmode [mode name]
  33. * [mode name] should be one of the following (mproc, mthread, or asyncnet)
  34. Contributing
  35. ------------
  36. Contributions are very welcome. Tests can be run with `tox`_, please ensure
  37. the coverage at least stays the same before you submit a pull request.
  38. License
  39. -------
  40. Distributed under the terms of the `MIT`_ license, "pytest-concurrent" is free and open source software
  41. Issues
  42. ------
  43. If you encounter any problems, please `file an issue`_ along with a detailed description.
  44. .. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
  45. .. _`@hackebrot`: https://github.com/hackebrot
  46. .. _`MIT`: http://opensource.org/licenses/MIT
  47. .. _`BSD-3`: http://opensource.org/licenses/BSD-3-Clause
  48. .. _`GNU GPL v3.0`: http://www.gnu.org/licenses/gpl-3.0.txt
  49. .. _`Apache Software License 2.0`: http://www.apache.org/licenses/LICENSE-2.0
  50. .. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
  51. .. _`file an issue`: https://github.com/reverbc/pytest-concurrent/issues
  52. .. _`pytest`: https://github.com/pytest-dev/pytest
  53. .. _`tox`: https://tox.readthedocs.io/en/latest/
  54. .. _`pip`: https://pypi.python.org/pypi/pip/
  55. .. _`PyPI`: https://pypi.python.org/pypi