Skip to main content

Flake8 based checking for jupyter notebooks

Project description

flake8-nb

License

Test Status Linux and OsX Test Status Windows Documentation Status Test Coverage 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.1 (2019-10-24)

  • added console-script 'flake8-nb' as 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.1.tar.gz (35.8 kB view details)

Uploaded Source

Built Distribution

flake8_nb-0.1.1-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_nb-0.1.1.tar.gz
  • Upload date:
  • Size: 35.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for flake8_nb-0.1.1.tar.gz
Algorithm Hash digest
SHA256 07cf86265cf8ddf17e438977b5717eaa77f8aa9e88b0fcca94c2e30f7e25fe2b
MD5 daa27f6a4479e6d2b50d58820832aa1a
BLAKE2b-256 f377514709132d6681fffdda6bc06b459a57886e456d6067e3a3a85aa75d629b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_nb-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 20.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for flake8_nb-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 68fd0167071c4f5f11d71d754643d85e04256636e355373a5bf03a838c36fa41
MD5 ce40e82d136b25351a20bf290b1ee73c
BLAKE2b-256 785f4b58e99f19d25de0207226bc1393aa04b61627426e43fe73ce5356245a34

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