Skip to main content

Flake8 based checking for jupyter notebooks

Project description

flake8-nb

PyPi Version Conda Version Supported Python Versions License

Actions Status Documentation Status codecov Updates

BCH compliance 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 formating
  • 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
Sebastian Weigand

💻 🤔 🚧 📆 🚇 ⚠️ 📖

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

History

0.1.4 (2020-01-01)

  • Set max 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.

Source Distribution

flake8_nb-0.1.4.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

flake8_nb-0.1.4-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file flake8_nb-0.1.4.tar.gz.

File metadata

  • Download URL: flake8_nb-0.1.4.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6

File hashes

Hashes for flake8_nb-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8c9bf95440e63bf6665c002620d127892f0d4eee9bf275975252b938f62fd287
MD5 d8086f020f09ffa9f36877358e6e580d
BLAKE2b-256 d9059ce427262a74332c97d28ebb9ddab3eda10c4b8bca74a130179ec927c6ec

See more details on using hashes here.

File details

Details for the file flake8_nb-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: flake8_nb-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.6

File hashes

Hashes for flake8_nb-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9346344e2840c25d41ecb5936530f49d25501193900a509c30270263ba07f5d2
MD5 e9a22d248e96208c3421ca55e1257358
BLAKE2b-256 f334baaf09442a978b8430308fea7eb33a3c5b579ad2ae7eb633573360900c0d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page