DESCRIPTION.rst 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. ===============================
  2. pytest-pycharm
  3. ===============================
  4. .. image:: https://badge.fury.io/py/pytest-pycharm.png
  5. :target: http://badge.fury.io/py/pytest-pycharm
  6. Plugin for ``pytest`` to enter PyCharm debugger on uncaught exceptions
  7. * Free software: BSD license
  8. Features
  9. --------
  10. * Uncaught exceptions in ``pytest`` test cases will trigger the PyCharm
  11. debugger
  12. Installation
  13. ------------
  14. You can install the plugin by running
  15. pip install pytest-pycharm
  16. Alternately check out the source code and run
  17. python setup.py install
  18. Usage
  19. -----
  20. You are ready to go right after the plugin installation. Execute any test in
  21. PyCharm by right-clicking on a test and selecting *Debug pytest in ...*. The
  22. debugger will pause on a false assertion (see `test example`_).
  23. The plugin also works with custom ``pytest`` Run Configurations:
  24. *Run | Edit Configurations | Add New Configuration | Python tests | pytest*.
  25. **Note:** make sure the Run Configuration uses the correct interpreter with
  26. ``pytest-pycharm`` installed.
  27. .. _test example: test_dummy.py