jupytext¶

Objective

jupyter notebook(.ipynb) 파일은 binary로 버전 관리가 어려움.
jupytext는 ipynb 파일을 .py, .md 등 plain text 형태 파일로 전환해주는 것임.
.py, .md 파일 형태로 github를 통해 버전관리를 할 수 있음

1. install¶

#!pdm add jupytext

!pdm show jupytext

Name:                  jupytext                                                 
Latest version:        1.14.7                                                   
Latest stable version: 1.14.7                                                   
Installed version:     1.14.6                                                   
Summary:               Jupyter notebooks as Markdown documents, Julia, Python or
                       R scripts                                                
Requires Python:       ~=3.6                                                    
Author:                Marc Wouts                                               
Author email:          marc.wouts@gmail.com                                     
License:               MIT                                                      
Homepage:              https://github.com/mwouts/jupytext                       
Project URLs:                                                                   
Platform:                                                                       
Keywords:                                                                       

2. config¶

2.1. jupytext config 디렉토리¶

* 아래 디렉토리 리스트에 jupytext config 파일 생성 가능

from jupytext.config import global_jupytext_configuration_directories
list(global_jupytext_configuration_directories())

['/home/runner/.config/jupytext',
 '/home/runner/.config',
 '/usr/local/share/jupytext',
 '/usr/local/share/',
 '/usr/share/jupytext',
 '/usr/share/']

2.2. comfig 파일 생성¶

jupytext.yml (yml파일 혁식)
- 위치: 위 디렉토리 중 선택
  기본적으로 jupytext는 ipynb, md 파일을 동일 디렉토리에 생성/저장 저장 경로를 다르게 하기 위한 config 파일 구성임.
  formats: “경로/prefix/확장자, 경로/prefix/확장자”
```
    formats: "ipynb, _md//.md"
```
pyproject.toml 파일에 기록 (pdm, poetry 등 python package 관리 툴 사용하는 경우)
- 위치: {프로젝트 폴더}/.pyproject.toml
- 작성
```
[tool.jupytext]
formats = "ipynb, _md/_/.md"
```

2.3. jupytext.yml 파일 인식여부 확인¶

from jupytext.config import find_jupytext_configuration_file
find_jupytext_configuration_file('.')

2.4. jupyter notebook 실행¶

3. execute¶

notebook 실행 후 ipynb 파일 생성
pairing: file > jupytext > Pair Notebook with Markdown 메뉴 선택
save: jupytext_01.ipynb 파일 저장하면 동시에 scripts 폴더 내 jupytext_01.md 파일 저장

!tree -l

.
├──  _md
│   ├── _Untitled.md
│   ├── _jupytext_01.md
│   ├── _myst.md
│   ├── _sphinx_01.md
│   └── _sphinx_02.md
├── autodoc.md
├── jb
│   ├──  _md
│   │   └── _quickstart.md
│   ├── config.md
│   ├── ghp.md
│   ├── img
│   │   ├── ghp_01.png
│   │   ├── ghp_02.png
│   │   ├── ghp_site_01.png
│   │   ├── git_action_02.png
│   │   ├── jb_01.png
│   │   ├── jb_02.png
│   │   └── jb_build_01.png
│   ├── intro_area.md
│   ├── overview.md
│   ├── quick-start.md
│   ├── quickstart.ipynb
│   └── toc.md
├── jupyter-book.md
├── jupytext_01.ipynb
├── markdown.md
├── markup.md
├── mermaid.md
├── myst.ipynb
├── rst.md
├── sphinx.md
├── sphinx_01.ipynb
├── sphinx_02.ipynb
├── sphinx_ext.ipynb
└── thebe.md

4 directories, 33 files

bug¶

1. pairing¶

paring 하는 2가지 방법
1. jupyter notebook에서 pairing
  - notebook File > jupytext > Pair notebook with ~ 선택
2. configuration 파일에서 설정
  - 위 config 방법으로 설정 시 notebook 에서 Pair 설정할 경우 pair 파일 중복