![](\"https://avatars1.githubusercontent.com/u/35495466?s=460&v=4\"\n)
\n Carson Quigley
\n![](\"https://avatars3.githubusercontent.com/u/31478979?s=460&v=4\"\n)
\n Lancaster Wu
\n![](\"https://avatars3.githubusercontent.com/u/31478964?s=460v=4\"\n)
\n Spencer Huang
\n![](\"https://avatars3.githubusercontent.com/u/31668620?s=460v=4\"\n)
\n Patrick Palad
\n![](\"https://avatars3.githubusercontent.com/u/46819028?s=460&v=4\"\n)
\n ![](\"https://img.shields.io/github/release/inTestiGator/pytest-blame.svg\")
](https://github.com/inTestiGator/pytest-blame/releases)\n[](\nhttps://gitter.im/pytest-blame/community)\n\nA pytest plugin that helps developers build successful test cases by providing\nthem with GitHub commit information when their test cases fail.\n\n## A Python Plugin for Tracking Test Case Status\n\n---\n\nEveryone uses pytest. Or at least, everyone should. It's a super useful testing\nprogram with an easy-to-use syntax. Pytest Blame is a pytest plugin that allows\npytest to do a quick check to Github to make sure the most recent commit is\npassing your cases. If somebody broke your cases, ``pytest-blame`` will display\nall the commits pushed since the build broke as well as who pushed each commit.\nThis keeps team workflow transparent and allows for semi-realtime updates from\nGithub without having to open a browser. Since ``pytest-blame`` can check up on\nthe online repository as frequently as every time you run your test suite, there\nis less risk of a broken commit going unnoticed until a merge conflict occurs.\n\n## Installation\n\n---\n\nTo install ``pytest-blame`` you will need to clone this github repository. Once\nthe repository has been cloned you will need to run the install script to update\nyour pytest configuration:\n\n```\npipenv run python setup.py install\n```\n\nAfter ``pytest-blame`` has been successfully installed you will need to generate\na Github User Token.\n\n*This can be found under ``Settings`` in your github profile:*\n\n\n\n![\"key1](\n\"https://github.com/inTestiGator/pytest-blame/blob/master/.github/key1.gif?raw=true\"\n)
\n\nThen, find ``Developer Settings`` in the dashboard on the left and navigate to\n``Personal Access Tokens``.\n\n![\"key2](\n\"https://github.com/inTestiGator/pytest-blame/blob/master/.github/key2.gif?raw=true\"\n)
\n\nFinally, when generating the key for ``pytest-blame`` make sure to include\nrights to ``repo`` and ``hooks``\n\n![\"key3](\n\"https://github.com/inTestiGator/pytest-blame/blob/master/.github/key3.gif?raw=true\"\n)
\n\n\nNow that you have a user token, you will need to paste it into the location where\nyour terminal is sourced from. For example: Ubuntu uses ``bash``, so the default\nterminal source for ubuntu is ``.bashrc``.\n\nYou should put the following code in dot files to set up environment variable:\n\n```shell\nexport GITHUB_OAUTH_TOKEN = \"YOUR_TOKEN\"\n```\n\nIf you are using Windows, you can go to `Control Panel -> System and Security ->\nSystem -> Advanced system settings -> Advanced -> Environment Variables` to\nset it up.\n\n## Usage\n\nYou can run pytest with the ``--track`` option and you will see a report\ncontaining GitHub information at the top of your pytest report.\n``pytest-blame`` will display the most recent commit that is passing CI\ncheck, and all commits that did not pass CI check between the most\nrecent commit and the most recent passing commit.\n\nTo run:\n``pytest --track tests/`` will invoke ``pytest-blame``, displaying the current\nstatus of your working branch in the pytest header.\n\n## Sample output\n\n---\n\nA successful ``pytest-blame`` run will look something like this:\n\n```\npytest --track tests/\n```\n\nOutput:\n\n```\nThe most recent commit is passing: https://github.com/inTestiGator/pytest-blame/commit/88ebf4107bc88d247a137d98ec9b45f6ae2658d3\nLancaster Wu : Delete index.md\n```\n\nor\n\n```\nMost recent passing commit: https://github.com/inTestiGator/pytest-blame/commit/4d4c5cb72cc86cfe35fb19e7630699f405677c69\n\nPatrick Palad: Disable pylint check\n\n--------------------------------\nFailing commit: https://github.com/inTestiGator/pytest-blame/commit/9d5d00bc8276d1efefb6beed39186b1bd9c64946\nSpencer Huang: return to passing commit\n\nFailing commit: https://github.com/inTestiGator/pytest-blame/commit/03c68b6ff910ab46407c01ce382c7161f5906d43\nSpencer Huang: failing commit\n\nFailing commit: https://github.com/inTestiGator/pytest-blame/commit/aab2684e748be41a73213861d1cedc4b5842f81a\nSpencer Huang: failling commit\n\nFailing commit: https://github.com/inTestiGator/pytest-blame/commit/4d4c5cb72cc86cfe35fb19e7630699f405677c69\nSpencer Huang: fail test\n\nThe last one is the most recent commit\n```\n\nYou may also recieve messages telling you that `can not find passing commits` when\nall commits are currently failing or pending.\n\n## Failing Travis build\n\nThe master branch is failing Travis because one of our test cases requires\nTravis to have access to our test repository and currently and it doesn't,\nso it cannot perform the actual testing. This test case passes locally.\n\n## The Team\n\nCheck out the Pytest Blame Team!\n\n\n \n \n Carson Quigley\n | \n \n \n \n Lancaster Wu\n | \n \n \n \n Spencer Huang\n | \n \n \n \n Patrick Palad\n | \n \n \n \n Paul Livingston\n |