Skip to main content

Flake8 based checking for jupyter notebooks

Project description

flake8-nb

PyPi Version Conda Version Supported Python Versions 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.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.3.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

flake8_nb-0.1.3-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_nb-0.1.3.tar.gz
  • Upload date:
  • Size: 36.3 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.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7

File hashes

Hashes for flake8_nb-0.1.3.tar.gz
Algorithm Hash digest
SHA256 b46199c41a1fa5d5fc9bf06a29ecc04d8c7bec99fd7b228fb5f61b9a30438f73
MD5 cf30ff6d99d54899b284687e2052e76b
BLAKE2b-256 65a9164b12c1c75df1fb6fe8149b14d54f243de5c736f0c95e1b473f4f73fc35

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_nb-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 20.9 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.6.0 requests-toolbelt/0.9.1 tqdm/4.38.0 CPython/3.6.7

File hashes

Hashes for flake8_nb-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b3e27d0750c06b4327b5dd8cba8f2619d77290ff997761a271a0c258a464077b
MD5 e358c7e93be2b0ec1b24f32171d7062e
BLAKE2b-256 06a3eb1fb2cfb267c6c8357424bbb6f0a9d5bb596112de575e8011d6a22ff0b1

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