Verifying PEP8 in iPython notebook code

Install the pep8 extension for ipython notebook using the following command :

%install_ext https://raw.githubusercontent.com/SiggyF/notebooks/master/pep8_magic.py

Refer the official docs for more info.

After that use the %%pep8 Cell magic function to check your particular cell for pep8 styling.

Note that this has to be put inside every cell for which pep8 checking needs to be enforced.

Refer this example.

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.

To turn off the auto-compliance-checking run:

%pycodestyle_off or %flake8_off

You could include parts of my script (link below) to see details which code lines need specific PEP8 corrections. You could also runs it independently.

The script includes PEP8 comments into the py file code based on flake8.
This makes it very easy to immediately jump to the place where the correction of the style is needed.

You can check it here:
https://github.com/Softerec/PEP8-commenter

I’d suggest using nbQA for this:

pip install -U nbqa flake8
conttest "nbqa flake8 notebook.ipynb"

as it’ll skip markdown cells and robustly handle IPython magics.

Issues with the other answers are:

• "jupyter nbconvert" won’t be robust to magics
• pycodestyle_magic is unfortunately no longer maintained (last commit is from 2019)
• install_ext is deprecated

disclaimer: I’m the author of nbQA

If you want to free yourself from bugs in the code or program that will pay you too much attention to EPE8, install two correction programs at once.

we install it:

pip install nb_black   
pip install flake8 pycodestyle_magic

paste into the code at the beginning:

%load_ext nb_black
%load_ext pycodestyle_magic 
%pycodestyle_on 

attention the order is important

I like keeping my notebooks tidy using the combination of the black linter and pre-commit git hooks (to automatically lint with every commit).

pip install pre-commit "black[jupyter]"
# <-- create your .pre-commit-config.yaml
pre-commit install
black {source_file_or_directory}
# your notebooks will be linted whenever you commit now

For instructions on how to setup your .pre-commit-config.yaml, see the black docs) and pre-commit docs.