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

🐛

Shoma Okamoto

⚠️

Marco Gorelli

🔧 📖

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

History

0.2.0 (2020-07-18)

  • Added pre-commit hook (#47)

0.1.8 (2020-06-09)

  • Set max supported version of flake8 to be <=3.8.3

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

Uploaded Source

Built Distribution

flake8_nb-0.2.0-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_nb-0.2.0.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.4

File hashes

Hashes for flake8_nb-0.2.0.tar.gz
Algorithm Hash digest
SHA256 ac39f556d18ad9ab67d0a96ca9b4db392190ea1f541983520fe5a917d4c74ec2
MD5 fa83b866d7768485ecb77dfad146a19b
BLAKE2b-256 b638b3c11822538e7c9d0fdd85454fdcee19636b583584fa3cd24330268988d5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_nb-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 21.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.4

File hashes

Hashes for flake8_nb-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 00a4c427088e5f3711dcc82a2eadef64e6fdf50432835e6f8890ac1198e2884b
MD5 5667f8282bd1273deac5e81ef29c2ed9
BLAKE2b-256 8e8c7e41deb3bced976b620ec51c1027443375701fc5b50586144823c97e02fa

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