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 Dependabot Status

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

💻 🤔 🚧 📆 🚇 ⚠️ 📖

Jt Miclat

🐛

Philipp Eisenhauer

🐛

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

History

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.

Source Distribution

flake8_nb-0.1.7.tar.gz (38.1 kB view details)

Uploaded Source

Built Distribution

flake8_nb-0.1.7-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_nb-0.1.7.tar.gz
  • Upload date:
  • Size: 38.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for flake8_nb-0.1.7.tar.gz
Algorithm Hash digest
SHA256 b68a0fdfbca6ddaaba03dfbde65137e11ed0e623c52b876dea450da3f6818229
MD5 64be8ea378252ca3978a69a70af40edf
BLAKE2b-256 608fcd1da19910029bc2ab29e943cc0d8a41dda20e94cf4c99725484573cf42f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_nb-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

File hashes

Hashes for flake8_nb-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7de101edc36b1cf9c7691de3489434ae9d8afbcee415cdec0189dc545823f77c
MD5 a80b112c539964691760b59eec4e46cc
BLAKE2b-256 701a66b99f780a81e0fe12b32a1f7e92987b6c33d5e0a33774e4f04e62cbc391

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