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.
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_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.6 (2020-03-21)
- Set max supported version of
flake8
to be<3.9.1
0.2.5 (2020-10-06)
- Added official Python 3.9 support and tests
0.2.4 (2020-10-04)
- Set max supported version of
flake8
to be<3.8.5
0.2.3 (2020-10-02)
- Fixed pre-commit hook file association so it support python and juypter notebooks
0.2.1 (2020-08-11)
- Forced uft8 encoding when reading notebooks, this prevents errors on windows when console codepage is assumed
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 offlake8
'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
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
File details
Details for the file flake8_nb-0.2.6.tar.gz
.
File metadata
- Download URL: flake8_nb-0.2.6.tar.gz
- Upload date:
- Size: 38.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcc0604c3386545c36952ede2d5cf3133cbd5c717d7b4bbc691d02183d16cbb7 |
|
MD5 | 8814b5dd47a78b539482c5a6c6665021 |
|
BLAKE2b-256 | 70d29c5fe0c856a94b1396141820470cdf8fd35f84100221ca3ae5733dd692b6 |
File details
Details for the file flake8_nb-0.2.6-py3-none-any.whl
.
File metadata
- Download URL: flake8_nb-0.2.6-py3-none-any.whl
- Upload date:
- Size: 22.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d362233209466374b1f2f3c54aa24065fa4067ae5bec8bb3167c5a3a52285e30 |
|
MD5 | 22a34498940417f9c328734ba7e593a5 |
|
BLAKE2b-256 | 1acfc0ed0a8432f20a971a66888c54dd21d809215ddb948f56326279db695fd1 |