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.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.2.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

flake8_nb-0.1.2-py3-none-any.whl (20.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_nb-0.1.2.tar.gz
  • Upload date:
  • Size: 35.9 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.5.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for flake8_nb-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b3c8e43f00d639200c8e74d32787aa87c6246296af2092524aa6e37d06fbc4ff
MD5 9c6b9e99485c998ca4f317a6a2610bcf
BLAKE2b-256 95ae79085cf8570bea9d700669aa5eb2e5f60a5ab8d729130754a845f82494d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_nb-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.8 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.5.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.7

File hashes

Hashes for flake8_nb-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9b823820ac258374a987c9677bbf3e270c1238d29f2847a44a1e3031db965f32
MD5 f51d791ed622e677458573eadc75cbc9
BLAKE2b-256 f2b70c92a4392e40f1d90ee994fbeff49beb01f6a5e8dbe03ccbf40472587dfd

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