Document structures for collaborative editing using Ypy
Project Links
Meta
Author: Jupyter Development Team
Requires Python: >=3.10
Classifiers
jupyter_ydoc
jupyter_ydoc provides pycrdt-based data structures for various
documents used in the Jupyter ecosystem. Built-in documents include:
YBlob: a generic immutable binary document.YUnicode: a generic UTF8-encoded text document (YFileis an alias toYUnicode).YNotebook: a Jupyter notebook document.
These documents are registered via an entry point under the "jupyter_ydoc" group as "blob",
"unicode" (or "file"), and "notebook", respectively. You can access them as follows:
from jupyter_ydoc import ydocs
print(ydocs)
# {
# 'blob': <class 'jupyter_ydoc.yblob.YBlob'>,
# 'file': <class 'jupyter_ydoc.yfile.YFile'>,
# 'notebook': <class 'jupyter_ydoc.ynotebook.YNotebook'>,
# 'unicode': <class 'jupyter_ydoc.yunicode.YUnicode'>
# }
Which is just a shortcut to:
from importlib.metadata import entry_points
ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}
Or directly import them:
from jupyter_ydoc import YBlob, YUnicode, YNotebook
The "jupyter_ydoc" entry point group can be populated with your own documents, e.g. by adding the
following to your package's pyproject.toml:
[project.entry-points.jupyter_ydoc]
my_document = "my_package.my_file:MyDocumentClass"
3.4.0
Feb 06, 2026
3.3.6
Feb 05, 2026
3.3.5
Feb 03, 2026
3.3.4
Jan 09, 2026
3.3.3
Dec 10, 2025
3.3.2
Dec 01, 2025
3.3.1
Nov 21, 2025
3.3.0
Nov 21, 2025
3.2.1
Nov 18, 2025
3.2.0
Nov 17, 2025
3.1.0
Jul 01, 2025
3.0.5
May 07, 2025
3.0.4
Apr 18, 2025
3.0.3
Jan 28, 2025
3.0.2
Dec 02, 2024
3.0.1
Nov 18, 2024
3.0.0
Oct 29, 2024
3.0.0b0
Oct 18, 2024
3.0.0a10
Oct 17, 2024
3.0.0a9
Oct 10, 2024
3.0.0a8
Sep 26, 2024
3.0.0a7
Sep 18, 2024
3.0.0a6
Aug 30, 2024
3.0.0a5
Aug 23, 2024
3.0.0a4
Aug 19, 2024
3.0.0a3
Aug 07, 2024
3.0.0a2
Jul 12, 2024
3.0.0a1
Jul 05, 2024
3.0.0a0
Jun 26, 2024
2.1.5
Jan 28, 2025
2.1.4
Nov 29, 2024
2.1.3
Oct 18, 2024
2.1.2
Oct 10, 2024
2.1.1
Jul 10, 2024
2.1.0
Jul 10, 2024
2.0.1
Dec 26, 2023
2.0.0
Dec 08, 2023
1.1.1
Sep 29, 2023
1.1.0
Sep 21, 2023
1.1.0a0
Jun 29, 2023
1.0.2
Apr 14, 2023
1.0.1
Apr 11, 2023
1.0.0
Mar 29, 2023
0.3.4
Feb 22, 2023
0.3.3
Feb 21, 2023
0.3.2
Feb 20, 2023
0.3.1
Jan 26, 2023
0.3.0
Jan 24, 2023
0.3.0a6
Jan 19, 2023
0.3.0a5
Jan 17, 2023
0.3.0a4
Jan 14, 2023
0.3.0a3
Jan 13, 2023
0.3.0a2
Jan 05, 2023
0.3.0a1
Oct 26, 2022
0.3.0a0
Sep 26, 2022
0.2.5
Jul 18, 2023
0.2.4
Apr 12, 2023
0.2.3
Mar 10, 2023
0.2.2
Oct 26, 2022
0.2.1
Sep 29, 2022
0.2.0
Sep 26, 2022
0.1.17
Aug 01, 2022
0.1.16
Jul 27, 2022
0.1.15
Jul 27, 2022
0.1.14
Jul 26, 2022
0.1.13
Jul 04, 2022
0.1.12
Jul 01, 2022
0.1.11
Jun 09, 2022
0.1.10
May 19, 2022
0.1.9
May 19, 2022
0.1.8
May 12, 2022
0.1.7
May 11, 2022
0.1.6
May 11, 2022
0.1.5
May 10, 2022
0.1.4
May 09, 2022
0.1.3
May 05, 2022
0.1.2
May 05, 2022
0.1.1
May 04, 2022
0.1.0
May 02, 2022
