Skip to main content

Flake8 based checking for jupyter notebooks

Project description

flake8-nb

PyPi Version Conda Version Supported Python Versions Pre-commit License

Actions Status Documentation Status Testing Coverage Documentation Coverage Dependabot Status

Code quality All Contributors Code style Python: black Binder

flake8 checking for jupyter notebooks. Basically this is a hack on the flake8's Application class, which adds parsing and a cell based formatter for *.ipynb files.

Features

  • flake8 CLI tests for jupyter notebooks
  • Full base functionality of flake8 and its plugins
  • Input cell based error formatting
  • Report fine tuning with cell-tags (flake8-noqa-tags see usage)

Example

If you had a notebook with name example_notebook.ipynb, where the code cell which was executed as 34th cell (In[34]) had the following code:

bad_formated_dict = {"missing":"space"}

running flake8_nb would result in the following output.

$ flake8_nb example_notebook.ipynb
example_notebook.ipynb#In[34]:1:31: E231 missing whitespace after ':'

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Sebastian Weigand

💻 🤔 🚧 📆 🚇 ⚠️ 📖

Jt Miclat

🐛

Philipp Eisenhauer

🐛

Shoma Okamoto

⚠️

Marco Gorelli

🔧 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

History

0.2.5 (2020-10-06)

  • Added official Python 3.9 support and tests

0.2.4 (2020-10-04)

  • Set max supported version of flake8 to be <3.8.5

0.2.3 (2020-10-02)

  • Fixed pre-commit hook file association so it support python and juypter notebooks

0.2.1 (2020-08-11)

  • Forced uft8 encoding when reading notebooks, this prevents errors on windows when console codepage is assumed

0.2.0 (2020-07-18)

  • Added pre-commit hook (#47)

0.1.8 (2020-06-09)

  • Set max supported version of flake8 to be <=3.8.3

0.1.7 (2020-05-25)

  • Set max supported version of flake8 to be <=3.8.2

0.1.6 (2020-05-20)

  • Set max supported version of flake8 to be <=3.8.1
  • Fixed bug with --exclude option

0.1.4 (2020-01-01)

  • Set max supported version of flake8 to be <3.8.0, to prevent breaking due to changes of flake8's inner workings.

0.1.3 (2019-11-13)

  • Added official Python 3.8 support and tests

0.1.2 (2019-10-29)

  • Fixed compatibility with flake8==3.7.9

0.1.1 (2019-10-24)

  • Added console-script 'flake8-nb' as an alias for 'flake8_nb'

0.1.0 (2019-10-22)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for flake8-nb, version 0.2.5
Filename, size File type Python version Upload date Hashes
Filename, size flake8_nb-0.2.5-py3-none-any.whl (22.2 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size flake8_nb-0.2.5.tar.gz (38.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page