Flake8 based checking for jupyter notebooks
Project description
flake8-nb
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.
This is NOT A PLUGIN but a stand alone CLI tool/pre-commit hook to be used instead of the flake8
command/hook.
Features
- flake8 CLI tests for jupyter notebooks
- Full base functionality of
flake8
and its plugins - Input cell based error formatting
- 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_formatted_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!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flake8_nb-0.2.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b1a11a61819e0dab46d12ee7ff1813549a418a7cb4c72caa9d3e9a494bab1e9 |
|
MD5 | 2842133bd8bbe753f4c4700f43bf878f |
|
BLAKE2b-256 | ce04f3edcfc01c7f0003f94ab04e7e1ff39373d6612ce04745bd15dfa526a5e5 |