Verifying PEP8 in iPython notebook code

Seanny123 picture Seanny123 · Sep 30, 2014 · Viewed 19.6k times · Source

Is there an easy way to check that iPython notebook code, while it's being written, is compliant with PEP8?

Answer

Mattijn picture Mattijn · Nov 9, 2017

Make sure you've the module pycodestyle or flake8 to be able to check your code against the style guides. Then enable the magic function by using the pycodestyle_magic module (github repo):

pip install flake8 pycodestyle_magic
  • first load the magic in a Jupyter Notebook cell:

%load_ext pycodestyle_magic

  • and then turn on the magic to do compliance checking for each cell using:

%pycodestyle_on or %flake8_on

depending against which style guide you want to check.

enter image description here

To turn off the auto-compliance-checking run:

%pycodestyle_off or %flake8_off