https://github.com/betatim/joli
Joli notebooks
https://github.com/betatim/joli
Last synced: 3 months ago
JSON representation
Joli notebooks
- Host: GitHub
- URL: https://github.com/betatim/joli
- Owner: betatim
- License: bsd-3-clause
- Created: 2018-11-15T22:47:35.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-16T20:13:44.000Z (almost 7 years ago)
- Last Synced: 2025-05-08T00:51:16.268Z (6 months ago)
- Language: Python
- Size: 287 KB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# joli -- pretty notebooks
> "c’est du joli!"
```
pip install joli
joli notebook.ipynb
```
joli let's you lint your notebooks and it formats your code with `black`.
You can lint the code in your notebook but so far you can't lint the whole
notebook. Examples of lint in a notebook:
* cells executed out of order
* a mixture of executed and unexecuted cells
* too much code compared to narrative text
## Goal
The goal of joli is to provide feedback to humans and editors about lint in a
notebook. Notebook frontends should be able to implement the notebook equivalent
of putting little wiggly underlines under your code, but for notebooks.
The experience of running `joli a-notebook-file.ipynb` in a terminal should be
similar to running a linter/code formatter like `pep8` or `prettier` on a code
file.
## Developing
Checkout this repository and run `pip install -e.`. Try
`joli examples/out-of-order.ipynb` you should see some errors.