jtmv: a tool for renaming jupytext paired files

[lukeSmth]

Problem

Jupytext users have two options to rename paired files outside of the Jupyter interface:

1. Rename + sync + cleanup: Rename one file, regenerate all paired files with jupytext, and then delete all files with the old name.
2. Rename all: Rename all files manually.

(Paired file renaming is apparently automatic within Jupyter, see #190.)

Solution

I built a simple CLI tool to solve this. It renames all paired files in one step: jtmv.

# before: paired files workflow.ipynb, workflow.py, workflow.md
jtmv workflow.py flow.py
# after: paired filed flow.ipynb, flow.py, flow.md

Notes:

• Any extension can be passed to jtmv, not just .py.
• Any files tracked by git will be renamed with git mv.

Would love feedback from the community! Has anyone else run into this problem? What do contributors think about adding this functionality as a native jupytext command (--mv?).

---

Huge thanks to @mwouts and contributors for creating jupytext -- it's a key part of my workflow.