build: configure nbdime and gitattributes#9
Merged
Merged
Conversation
- Add `nbdime` to dev dependencies in pyproject.toml
- Create .gitattributes to configure repository file handling:
- Set default text behavior (* text=auto)
- Configure *.ipynb to use nbdime driver
- Mark data artifacts (*.npz, *.npy, *.bin) as binary
- Mark generated figures (*.svg, *.pdf) as binary
- Mark uv.lock as linguist-generated
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Integrates
nbdimeinto the development environment to improve diffing for Jupyter notebooks and establishes a.gitattributesfile to handle binary artifacts and generated files properly.Changes
nbdimeto thedevdependency group inpyproject.tomlviauv..gitattributesto:nbdimeas the diff driver for*.ipynbfiles..npz,.npy) and vector graphics (.svg,.pdf) as binary to suppress noisy text diffs.uv.lockas linguist-generated.* text=auto.Rationale
As a solo repository containing analysis pipelines with heavy visual outputs (harmonic landscapes, joyplots), preserving notebook outputs is intentional.
nbdimeallows for readable diffs locally without forcing a strip-out policy on the remote. Explicit binary handling prevents git from attempting to diff large NumPy archives or XML-based SVG figures.