bloomberg / bloomberg/causal-ts
[Feature]: Use Jupytext for cleaner notebook diffs
- Dominant language
- Python
- Stars
- 36
- Forks
- 15
- Avg merge
- 4h 1m
- Merged PRs (30d)
- 36
Description
### Problem Statement
Notebook diffs are often noisy because they include saved outputs.
### Proposed Solution
I suggest using [Jupytext](https://github.com/jupytext/jupytext) to pair notebooks with text-based source files (eg .py files), making changes easier to review and merge.
We could trial it on a couple of notebooks first and decide how to handle syncing, outputs, and widgets.
### Alternatives Considered
_No response_
### Additional Context
_No response_
### Checklist
- [x] I have read the [contributing guidelines](/bloomberg/causal-ts/blob/main/CONTRIBUTING.md)
- [x] I have verified this does not duplicate an existing feature request
Contributor guide
Research direction
Start by selecting the couple of notebooks for the proposed Jupytext trial and review how their saved outputs and widgets are currently handled. Read Jupytext's pairing and syncing guidance, then define a documented workflow whose completion criteria cover text-based diffs, synchronization, outputs, and widgets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100