Repository files navigation

jupyter_ydoc providespycrdt-based data structures for variousdocuments used in the Jupyter ecosystem. Built-in documents include:

• YBlob: a generic immutable binary document.
• YUnicode: a generic UTF8-encoded text document (YFile is 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:

fromjupyter_ydocimportydocsprint(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:

fromimportlib.metadataimportentry_pointsydocs= {ep.name:ep.load()forepinentry_points(group="jupyter_ydoc")}

Or directly import them:

fromjupyter_ydocimportYBlob,YUnicode,YNotebook

The"jupyter_ydoc" entry point group can be populated with your own documents, e.g. by adding thefollowing to your package'spyproject.toml:

[project.entry-points.jupyter_ydoc]my_document = "my_package.my_file:MyDocumentClass"