https://github.com/alexandercbooth/nblint

A simple CLI tool to lint to Jupyter notebooks
https://github.com/alexandercbooth/nblint

cli eslint jupyter-notebook lint linter pycodestyle pyflakes

Last synced: about 2 months ago
JSON representation

A simple CLI tool to lint to Jupyter notebooks

• Host: GitHub
• URL: https://github.com/alexandercbooth/nblint
• Owner: alexandercbooth
• License: mit
• Created: 2017-01-24T04:53:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-02-02T03:39:58.000Z (over 7 years ago)
• Last Synced: 2024-07-22T15:42:39.800Z (about 2 months ago)
• Topics: cli, eslint, jupyter-notebook, lint, linter, pycodestyle, pyflakes
• Language: Python
• Homepage:
• Size: 1.34 MB
• Stars: 17
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nblint

[![Build Status](https://travis-ci.com/alexandercbooth/nblint.svg?token=UDZsiVdppziAsV1HLtLw&branch=master)](https://travis-ci.com/alexandercbooth/nblint) [![Build status](https://ci.appveyor.com/api/projects/status/53ddbl40npfp9mre?svg=true)](https://ci.appveyor.com/project/alexandercbooth/nblint)

Lint Jupyter notebooks like a boss

---

![](boss.gif)

A simple CLI tool to lint to Jupyter notebooks.

## Installation

with pip

```bash

$ pip install nblint

```

or bleeding edge

```bash

$ git clone https://github.com/alexandercbooth/nblint.git

$ python setup.py install

```

## Usage

### Python

Runs pycodestyle as the default linter and supports pyflakes

```bash

$ nblint pythonNotebook.ipynb

```

or pyflakes:

```bash

$ nblint --linter pyflakes pythonNotebook.ipynb

```

Currently supports the following other languages

## Go

```bash

$ nblint --linter golint goNotebook.ipynb

```

## JavaScript (es6)

```bash

$ nblint --linter eslint jsNotebook.ipynb

```