https://github.com/dprint/dprint-plugin-jupyter

Formats code blocks in Jupyter notebooks.
https://github.com/dprint/dprint-plugin-jupyter

Last synced: about 1 year ago
JSON representation

Formats code blocks in Jupyter notebooks.

• Host: GitHub
• URL: https://github.com/dprint/dprint-plugin-jupyter
• Owner: dprint
• License: mit
• Created: 2023-11-24T00:11:40.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T20:16:38.000Z (over 2 years ago)
• Last Synced: 2024-05-01T11:24:22.221Z (about 2 years ago)
• Language: Rust
• Homepage: https://dprint.dev/plugins/jupyter
• Size: 26.4 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# dprint-plugin-jupyter

[![](https://img.shields.io/crates/v/dprint-plugin-jupyter.svg)](https://crates.io/crates/dprint-plugin-jupyter) [![CI](https://github.com/dprint/dprint-plugin-jupyter/workflows/CI/badge.svg)](https://github.com/dprint/dprint-plugin-jupyter/actions?query=workflow%3ACI)

Formats code blocks in Jupyter notebook files (`.ipynb`) using dprint plugins.

## Install

[Install](https://dprint.dev/install/) and [setup](https://dprint.dev/setup/) dprint.

Then in your project's directory with a dprint.json file, run:

```shellsession

dprint config add jupyter

```

Then add some additional formatting plugins to format the code blocks with. For example:

```shellsession

dprint config add typescript

dprint config add markdown

dprint config add ruff

```

If you find a code block isn't being formatted with a plugin, please verify it's not a syntax error. After, open an [issue](https://github.com/dprint/dprint-plugin-jupyter/issues) about adding support for that plugin (if you're interested in opening a PR, it's potentially an easy contribution).

## Configuration

Configuration is handled in other plugins.