1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
|
%global _empty_manifest_terminate_build 0
Name: python-jupytext
Version: 1.14.5
Release: 1
Summary: Jupyter notebooks as Markdown documents, Julia, Python or R scripts
License: MIT
URL: https://github.com/mwouts/jupytext
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/0a/7f/c495114a3814df1d9d41855e939a6a0cb133a1a11a34a22bde934d115ff4/jupytext-1.14.5.tar.gz
BuildArch: noarch
Requires: python3-nbformat
Requires: python3-pyyaml
Requires: python3-toml
Requires: python3-markdown-it-py
Requires: python3-mdit-py-plugins
Requires: python3-sphinx-gallery
Requires: python3-toml
%description
[](https://jupytext.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/mwouts/jupytext/branch/main)
[](https://lgtm.com/projects/g/mwouts/jupytext/context:python)
[](https://github.com/psf/black)
[](https://jupytext.readthedocs.io/en/latest/languages.html)
[](https://anaconda.org/conda-forge/jupytext)
[](https://pypi.python.org/pypi/jupytext)
[](https://pypi.python.org/pypi/jupytext)
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
[](https://renkulab.io/projects/best-practices/jupytext/sessions/new?autostart=1)
[](https://www.youtube.com/watch?v=SDYdeVfMh48)
Have you always wished Jupyter notebooks were plain text documents? Wished you could edit them in your favorite IDE? And get clear and meaningful diffs when doing version control? Then... Jupytext may well be the tool you're looking for!
Jupytext is a plugin for Jupyter that can save Jupyter notebooks as either
- Markdown files (or [MyST Markdown](https://jupytext.readthedocs.io/en/latest/formats.html#MyST-Markdown) files, or [R Markdown](https://jupytext.readthedocs.io/en/latest/formats.html#R-Markdown) or [Quarto](https://jupytext.readthedocs.io/en/latest/formats.html#Quarto) text notebooks)
- Scripts in [many languages](https://jupytext.readthedocs.io/en/latest/languages.html).
## Use cases
Common [use cases](https://jupytext.readthedocs.io/en/latest/examples.html) for Jupytext are:
- Doing version control on Jupyter Notebooks
- Editing, merging or refactoring notebooks in your favorite text editor
- Applying Q&A checks on notebooks.
## Install
You can install Jupytext with
- `pip install jupytext`
- or `conda install jupytext -c conda-forge`.
Please note that Jupytext includes an extension for Jupyter Lab. In the latest version of Jupytext, this extension is compatible with Jupyter Lab >= 3.0 only. If you use Jupyter Lab 2.x, please either stay with Jupytext 1.8.2, or install, on top of the latest pip or conda version of Jupytext, a version of the extension that is compatible with Jupyter Lab 2.x:
```
jupyter labextension install jupyterlab-jupytext@1.2.2 # For Jupyter Lab 2.x
```
Then, restart your Jupyter server (for more installation details, see the [install section](https://jupytext.readthedocs.io/en/latest/install.html) in the documentation).
When Jupytext is installed, `.py` and `.md` files have a notebook icon. And you can really open and run these files as notebooks
<ul>
<details>
<summary>With a click on the text file in Jupyter Notebook</summary>
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo))
</details>
<details>
<summary>With a click on the text file in JupyterLab (<b>⭐New⭐</b>)</summary>
To do that, you will need to change the default viewer for text notebooks by copy-pasting the following settings (or the subset that matches your use case) in the `Document Manager` section:
```json
{
"defaultViewers": {
"markdown": "Jupytext Notebook",
"myst": "Jupytext Notebook",
"r-markdown": "Jupytext Notebook",
"quarto": "Jupytext Notebook",
"julia": "Jupytext Notebook",
"python": "Jupytext Notebook",
"r": "Jupytext Notebook"
}
}
```
Here is a screencast of the steps to follow:
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb))
Another possibility is to activate this with a [default_setting_overrides.json](https://github.com/mwouts/jupytext/blob/main/binder/labconfig/default_setting_overrides.json) file in the `.jupyter/labconfig` folder with e.g.
```
wget https://raw.githubusercontent.com/mwouts/jupytext/main/binder/labconfig/default_setting_overrides.json -P ~/.jupyter/labconfig/
```
Note: to open links to `.md` files in notebooks with the Notebook editor, use `jupyterlab>=4.0.0a16`.
</details><details>
<summary>With a right click and <i>open with notebook</i> in Jupyter Lab</summary>
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb))
</details>
</ul>
## Paired notebooks
The most convenient way to use Jupytext is probably through [paired notebooks](https://jupytext.readthedocs.io/en/latest/paired-notebooks.html).
To pair a given `.ipynb` or text notebook to an additional notebook format, use either
<ul>
<details>
<summary>the <i>"pair notebook with..."</i> commands in Jupyter Lab</summary>
[](https://jupytext.readthedocs.io/en/latest/install.html#jupytext-commands-in-jupyterlab)
</details>
<details>
<summary>the <i>"pair notebook with..."</i> menu entries in Jupyter Notebook</summary>
[](https://jupytext.readthedocs.io/en/latest/install.html#Jupytext-menu-in-Jupyter-Notebook)
</details>
<details>
<summary><code>jupytext</code> at the command line</summary>
with e.g.
```
jupytext --set-formats ipynb,py:percent notebook.ipynb
```
see the [documentation](https://jupytext.readthedocs.io/en/latest/config.html#Per-notebook-configuration).
</details>
<details>
<summary>or a local or global <code>jupytext.toml</code> configuration file.</summary>
with e.g. the following content:
```
formats = "ipynb,py:percent"
```
see the [documentation](https://jupytext.readthedocs.io/en/latest/config.html#Configuring-paired-notebooks-globally).
</details>
</ul>
When you save a paired notebook in Jupyter, both the `.ipynb` file and the text version are updated on disk.
When a paired notebook is opened or _reloaded_ in Jupyter, the input cells are loaded from the text file, and combined with the output cells from the `.ipynb` file.
You can edit the text representation of the notebook in your favorite editor, and get the changes back in Jupyter by simply _reloading_ the notebook (Ctrl+R in Jupyter Notebook, <i>"reload notebook"</i> in Jupyter Lab). And the changes are propagated to the `.ipynb` file when you _save_ the notebook.
Alternatively, you can synchronise the two representations by running `jupytext --sync notebook.ipynb` at the command line.
## Which text format?
Jupytext implements many text [formats](https://jupytext.readthedocs.io/en/latest/formats.html) for Jupyter Notebooks. If your notebook is mostly made of code, you will probably prefer to save it as a script:
- Use the [percent format](https://jupytext.readthedocs.io/en/latest/formats.html#The-percent-format), a format with explicit cell delimiters (`# %%`), supported by many IDE (Spyder, Hydrogen, VS Code, PyCharm and PTVS)
- Or use the [light format](https://jupytext.readthedocs.io/en/latest/formats.html#The-light-format), if you prefer to see fewer cell markers.
If your notebook contains more text than code, if you are writing a documentation or a book, you probably want to save your notebook as a Markdown document
- Use the [Jupytext Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#Jupytext-Markdown) if you wish to render your notebook as a `.md` file (without its outputs) on GitHub
- Use the [MyST Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#MyST-Markdown), a markdown flavor that “implements the best parts of reStructuredText”, if you wish to render your notebooks using Sphinx or [Jupyter Book](https://jupyterbook.org).
- Use the [R Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#R-Markdown) or the [Quarto format](https://jupytext.readthedocs.io/en/latest/formats.html#Quarto) if you want to open your Jupyter Notebooks in RStudio.
## More resources?
If you're new to Jupytext, you may want to start with the [FAQ](https://jupytext.readthedocs.io/en/latest/faq.html) or with the [Tutorials](https://jupytext.readthedocs.io/en/latest/tutorials.html), or with this short introduction to Jupytext: [](https://www.youtube.com/watch?v=SDYdeVfMh48).
%package -n python3-jupytext
Summary: Jupyter notebooks as Markdown documents, Julia, Python or R scripts
Provides: python-jupytext
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-jupytext
[](https://jupytext.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/mwouts/jupytext/branch/main)
[](https://lgtm.com/projects/g/mwouts/jupytext/context:python)
[](https://github.com/psf/black)
[](https://jupytext.readthedocs.io/en/latest/languages.html)
[](https://anaconda.org/conda-forge/jupytext)
[](https://pypi.python.org/pypi/jupytext)
[](https://pypi.python.org/pypi/jupytext)
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
[](https://renkulab.io/projects/best-practices/jupytext/sessions/new?autostart=1)
[](https://www.youtube.com/watch?v=SDYdeVfMh48)
Have you always wished Jupyter notebooks were plain text documents? Wished you could edit them in your favorite IDE? And get clear and meaningful diffs when doing version control? Then... Jupytext may well be the tool you're looking for!
Jupytext is a plugin for Jupyter that can save Jupyter notebooks as either
- Markdown files (or [MyST Markdown](https://jupytext.readthedocs.io/en/latest/formats.html#MyST-Markdown) files, or [R Markdown](https://jupytext.readthedocs.io/en/latest/formats.html#R-Markdown) or [Quarto](https://jupytext.readthedocs.io/en/latest/formats.html#Quarto) text notebooks)
- Scripts in [many languages](https://jupytext.readthedocs.io/en/latest/languages.html).
## Use cases
Common [use cases](https://jupytext.readthedocs.io/en/latest/examples.html) for Jupytext are:
- Doing version control on Jupyter Notebooks
- Editing, merging or refactoring notebooks in your favorite text editor
- Applying Q&A checks on notebooks.
## Install
You can install Jupytext with
- `pip install jupytext`
- or `conda install jupytext -c conda-forge`.
Please note that Jupytext includes an extension for Jupyter Lab. In the latest version of Jupytext, this extension is compatible with Jupyter Lab >= 3.0 only. If you use Jupyter Lab 2.x, please either stay with Jupytext 1.8.2, or install, on top of the latest pip or conda version of Jupytext, a version of the extension that is compatible with Jupyter Lab 2.x:
```
jupyter labextension install jupyterlab-jupytext@1.2.2 # For Jupyter Lab 2.x
```
Then, restart your Jupyter server (for more installation details, see the [install section](https://jupytext.readthedocs.io/en/latest/install.html) in the documentation).
When Jupytext is installed, `.py` and `.md` files have a notebook icon. And you can really open and run these files as notebooks
<ul>
<details>
<summary>With a click on the text file in Jupyter Notebook</summary>
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo))
</details>
<details>
<summary>With a click on the text file in JupyterLab (<b>⭐New⭐</b>)</summary>
To do that, you will need to change the default viewer for text notebooks by copy-pasting the following settings (or the subset that matches your use case) in the `Document Manager` section:
```json
{
"defaultViewers": {
"markdown": "Jupytext Notebook",
"myst": "Jupytext Notebook",
"r-markdown": "Jupytext Notebook",
"quarto": "Jupytext Notebook",
"julia": "Jupytext Notebook",
"python": "Jupytext Notebook",
"r": "Jupytext Notebook"
}
}
```
Here is a screencast of the steps to follow:
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb))
Another possibility is to activate this with a [default_setting_overrides.json](https://github.com/mwouts/jupytext/blob/main/binder/labconfig/default_setting_overrides.json) file in the `.jupyter/labconfig` folder with e.g.
```
wget https://raw.githubusercontent.com/mwouts/jupytext/main/binder/labconfig/default_setting_overrides.json -P ~/.jupyter/labconfig/
```
Note: to open links to `.md` files in notebooks with the Notebook editor, use `jupyterlab>=4.0.0a16`.
</details><details>
<summary>With a right click and <i>open with notebook</i> in Jupyter Lab</summary>
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb))
</details>
</ul>
## Paired notebooks
The most convenient way to use Jupytext is probably through [paired notebooks](https://jupytext.readthedocs.io/en/latest/paired-notebooks.html).
To pair a given `.ipynb` or text notebook to an additional notebook format, use either
<ul>
<details>
<summary>the <i>"pair notebook with..."</i> commands in Jupyter Lab</summary>
[](https://jupytext.readthedocs.io/en/latest/install.html#jupytext-commands-in-jupyterlab)
</details>
<details>
<summary>the <i>"pair notebook with..."</i> menu entries in Jupyter Notebook</summary>
[](https://jupytext.readthedocs.io/en/latest/install.html#Jupytext-menu-in-Jupyter-Notebook)
</details>
<details>
<summary><code>jupytext</code> at the command line</summary>
with e.g.
```
jupytext --set-formats ipynb,py:percent notebook.ipynb
```
see the [documentation](https://jupytext.readthedocs.io/en/latest/config.html#Per-notebook-configuration).
</details>
<details>
<summary>or a local or global <code>jupytext.toml</code> configuration file.</summary>
with e.g. the following content:
```
formats = "ipynb,py:percent"
```
see the [documentation](https://jupytext.readthedocs.io/en/latest/config.html#Configuring-paired-notebooks-globally).
</details>
</ul>
When you save a paired notebook in Jupyter, both the `.ipynb` file and the text version are updated on disk.
When a paired notebook is opened or _reloaded_ in Jupyter, the input cells are loaded from the text file, and combined with the output cells from the `.ipynb` file.
You can edit the text representation of the notebook in your favorite editor, and get the changes back in Jupyter by simply _reloading_ the notebook (Ctrl+R in Jupyter Notebook, <i>"reload notebook"</i> in Jupyter Lab). And the changes are propagated to the `.ipynb` file when you _save_ the notebook.
Alternatively, you can synchronise the two representations by running `jupytext --sync notebook.ipynb` at the command line.
## Which text format?
Jupytext implements many text [formats](https://jupytext.readthedocs.io/en/latest/formats.html) for Jupyter Notebooks. If your notebook is mostly made of code, you will probably prefer to save it as a script:
- Use the [percent format](https://jupytext.readthedocs.io/en/latest/formats.html#The-percent-format), a format with explicit cell delimiters (`# %%`), supported by many IDE (Spyder, Hydrogen, VS Code, PyCharm and PTVS)
- Or use the [light format](https://jupytext.readthedocs.io/en/latest/formats.html#The-light-format), if you prefer to see fewer cell markers.
If your notebook contains more text than code, if you are writing a documentation or a book, you probably want to save your notebook as a Markdown document
- Use the [Jupytext Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#Jupytext-Markdown) if you wish to render your notebook as a `.md` file (without its outputs) on GitHub
- Use the [MyST Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#MyST-Markdown), a markdown flavor that “implements the best parts of reStructuredText”, if you wish to render your notebooks using Sphinx or [Jupyter Book](https://jupyterbook.org).
- Use the [R Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#R-Markdown) or the [Quarto format](https://jupytext.readthedocs.io/en/latest/formats.html#Quarto) if you want to open your Jupyter Notebooks in RStudio.
## More resources?
If you're new to Jupytext, you may want to start with the [FAQ](https://jupytext.readthedocs.io/en/latest/faq.html) or with the [Tutorials](https://jupytext.readthedocs.io/en/latest/tutorials.html), or with this short introduction to Jupytext: [](https://www.youtube.com/watch?v=SDYdeVfMh48).
%package help
Summary: Development documents and examples for jupytext
Provides: python3-jupytext-doc
%description help
[](https://jupytext.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/mwouts/jupytext/branch/main)
[](https://lgtm.com/projects/g/mwouts/jupytext/context:python)
[](https://github.com/psf/black)
[](https://jupytext.readthedocs.io/en/latest/languages.html)
[](https://anaconda.org/conda-forge/jupytext)
[](https://pypi.python.org/pypi/jupytext)
[](https://pypi.python.org/pypi/jupytext)
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
[](https://renkulab.io/projects/best-practices/jupytext/sessions/new?autostart=1)
[](https://www.youtube.com/watch?v=SDYdeVfMh48)
Have you always wished Jupyter notebooks were plain text documents? Wished you could edit them in your favorite IDE? And get clear and meaningful diffs when doing version control? Then... Jupytext may well be the tool you're looking for!
Jupytext is a plugin for Jupyter that can save Jupyter notebooks as either
- Markdown files (or [MyST Markdown](https://jupytext.readthedocs.io/en/latest/formats.html#MyST-Markdown) files, or [R Markdown](https://jupytext.readthedocs.io/en/latest/formats.html#R-Markdown) or [Quarto](https://jupytext.readthedocs.io/en/latest/formats.html#Quarto) text notebooks)
- Scripts in [many languages](https://jupytext.readthedocs.io/en/latest/languages.html).
## Use cases
Common [use cases](https://jupytext.readthedocs.io/en/latest/examples.html) for Jupytext are:
- Doing version control on Jupyter Notebooks
- Editing, merging or refactoring notebooks in your favorite text editor
- Applying Q&A checks on notebooks.
## Install
You can install Jupytext with
- `pip install jupytext`
- or `conda install jupytext -c conda-forge`.
Please note that Jupytext includes an extension for Jupyter Lab. In the latest version of Jupytext, this extension is compatible with Jupyter Lab >= 3.0 only. If you use Jupyter Lab 2.x, please either stay with Jupytext 1.8.2, or install, on top of the latest pip or conda version of Jupytext, a version of the extension that is compatible with Jupyter Lab 2.x:
```
jupyter labextension install jupyterlab-jupytext@1.2.2 # For Jupyter Lab 2.x
```
Then, restart your Jupyter server (for more installation details, see the [install section](https://jupytext.readthedocs.io/en/latest/install.html) in the documentation).
When Jupytext is installed, `.py` and `.md` files have a notebook icon. And you can really open and run these files as notebooks
<ul>
<details>
<summary>With a click on the text file in Jupyter Notebook</summary>
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?filepath=demo))
</details>
<details>
<summary>With a click on the text file in JupyterLab (<b>⭐New⭐</b>)</summary>
To do that, you will need to change the default viewer for text notebooks by copy-pasting the following settings (or the subset that matches your use case) in the `Document Manager` section:
```json
{
"defaultViewers": {
"markdown": "Jupytext Notebook",
"myst": "Jupytext Notebook",
"r-markdown": "Jupytext Notebook",
"quarto": "Jupytext Notebook",
"julia": "Jupytext Notebook",
"python": "Jupytext Notebook",
"r": "Jupytext Notebook"
}
}
```
Here is a screencast of the steps to follow:
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb))
Another possibility is to activate this with a [default_setting_overrides.json](https://github.com/mwouts/jupytext/blob/main/binder/labconfig/default_setting_overrides.json) file in the `.jupyter/labconfig` folder with e.g.
```
wget https://raw.githubusercontent.com/mwouts/jupytext/main/binder/labconfig/default_setting_overrides.json -P ~/.jupyter/labconfig/
```
Note: to open links to `.md` files in notebooks with the Notebook editor, use `jupyterlab>=4.0.0a16`.
</details><details>
<summary>With a right click and <i>open with notebook</i> in Jupyter Lab</summary>
[](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb)
(click on the image above to try this on [](https://mybinder.org/v2/gh/mwouts/jupytext/main?urlpath=lab/tree/demo/get_started.ipynb))
</details>
</ul>
## Paired notebooks
The most convenient way to use Jupytext is probably through [paired notebooks](https://jupytext.readthedocs.io/en/latest/paired-notebooks.html).
To pair a given `.ipynb` or text notebook to an additional notebook format, use either
<ul>
<details>
<summary>the <i>"pair notebook with..."</i> commands in Jupyter Lab</summary>
[](https://jupytext.readthedocs.io/en/latest/install.html#jupytext-commands-in-jupyterlab)
</details>
<details>
<summary>the <i>"pair notebook with..."</i> menu entries in Jupyter Notebook</summary>
[](https://jupytext.readthedocs.io/en/latest/install.html#Jupytext-menu-in-Jupyter-Notebook)
</details>
<details>
<summary><code>jupytext</code> at the command line</summary>
with e.g.
```
jupytext --set-formats ipynb,py:percent notebook.ipynb
```
see the [documentation](https://jupytext.readthedocs.io/en/latest/config.html#Per-notebook-configuration).
</details>
<details>
<summary>or a local or global <code>jupytext.toml</code> configuration file.</summary>
with e.g. the following content:
```
formats = "ipynb,py:percent"
```
see the [documentation](https://jupytext.readthedocs.io/en/latest/config.html#Configuring-paired-notebooks-globally).
</details>
</ul>
When you save a paired notebook in Jupyter, both the `.ipynb` file and the text version are updated on disk.
When a paired notebook is opened or _reloaded_ in Jupyter, the input cells are loaded from the text file, and combined with the output cells from the `.ipynb` file.
You can edit the text representation of the notebook in your favorite editor, and get the changes back in Jupyter by simply _reloading_ the notebook (Ctrl+R in Jupyter Notebook, <i>"reload notebook"</i> in Jupyter Lab). And the changes are propagated to the `.ipynb` file when you _save_ the notebook.
Alternatively, you can synchronise the two representations by running `jupytext --sync notebook.ipynb` at the command line.
## Which text format?
Jupytext implements many text [formats](https://jupytext.readthedocs.io/en/latest/formats.html) for Jupyter Notebooks. If your notebook is mostly made of code, you will probably prefer to save it as a script:
- Use the [percent format](https://jupytext.readthedocs.io/en/latest/formats.html#The-percent-format), a format with explicit cell delimiters (`# %%`), supported by many IDE (Spyder, Hydrogen, VS Code, PyCharm and PTVS)
- Or use the [light format](https://jupytext.readthedocs.io/en/latest/formats.html#The-light-format), if you prefer to see fewer cell markers.
If your notebook contains more text than code, if you are writing a documentation or a book, you probably want to save your notebook as a Markdown document
- Use the [Jupytext Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#Jupytext-Markdown) if you wish to render your notebook as a `.md` file (without its outputs) on GitHub
- Use the [MyST Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#MyST-Markdown), a markdown flavor that “implements the best parts of reStructuredText”, if you wish to render your notebooks using Sphinx or [Jupyter Book](https://jupyterbook.org).
- Use the [R Markdown format](https://jupytext.readthedocs.io/en/latest/formats.html#R-Markdown) or the [Quarto format](https://jupytext.readthedocs.io/en/latest/formats.html#Quarto) if you want to open your Jupyter Notebooks in RStudio.
## More resources?
If you're new to Jupytext, you may want to start with the [FAQ](https://jupytext.readthedocs.io/en/latest/faq.html) or with the [Tutorials](https://jupytext.readthedocs.io/en/latest/tutorials.html), or with this short introduction to Jupytext: [](https://www.youtube.com/watch?v=SDYdeVfMh48).
%prep
%autosetup -n jupytext-1.14.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-jupytext -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 1.14.5-1
- Package Spec generated
|
