pythoncontinuous-integrationcode-structurepycodestyle

How to use pep8speaks to check the code style/structure of my project


Reading the instructions here: https://pep8speaks.com/

and here: https://github.com/OrkoHunter/pep8speaks?installation_id=6398017&setup_action=update#configuration

I am a bit confused on how to use pep8speaks to check the code style/structure of my project.

Anyone have a rough step-by-step guide on how to use pep8speaks. Many thanks.

Edit: Screenshot of a Pull Request from my project pep8speaks

Edit no. 2: Screenshot of Fork "tab" pep8speaks2


Solution

  • Sure! Once you have installed and configure pep8speaks in your project, just submit a Pull Request (say with comment “Trigger pep8speaks“ and pep8speaks will reply back like a chat bot with all the checks. It will even send you an email of all the checks. In my case where my project was forked from another project, when the Pull Request is submitted from my project (to the other project), pep8speaks will do the check on just my project. Once you have the checks, you can then close the Pull Request which is sitting on the other project.