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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_nb-0.1.0.tar.gz
  • Upload date:
  • Size: 35.6 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.0.tar.gz
Algorithm Hash digest
SHA256 52a8d62f2c61f6d9c725c89c2b1d3a7e6f84093e688ff2ddc25bd77dcb9a3e3c
MD5 2ac3897c1332465905708f3fbfd358d1
BLAKE2b-256 e6a4c9092da70da80f08b76804057453e8cec3771b86e8a8dba884bc5d766ce9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_nb-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 82e2a4de43a7585f52858a523a374b315e3e7847158467fa48bda5a8cee8688d
MD5 9826d80b27622a224fd046103234ede8
BLAKE2b-256 60394722d66fc61633c310dfeda60baa160806a876990c98a757bdd9d6a77693

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