Skip to main content

Build Status Code style: black PyPI npm (scoped)

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 (YFile is an alias to YUnicode).
  • 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"

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter_ydoc-4.1.0.tar.gz (975.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyter_ydoc-4.1.0-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_ydoc-4.1.0.tar.gz.

File metadata

  • Download URL: jupyter_ydoc-4.1.0.tar.gz
  • Upload date:
  • Size: 975.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jupyter_ydoc-4.1.0.tar.gz
Algorithm Hash digest
SHA256 70a16a7ba6c8b3b046961622a0ac21d579660fa5675a31bb506e3ddd4c440155
MD5 21dbdb47d3fe6f82b2d6149ae1c213ca
BLAKE2b-256 1fae5706142ae5f5fba58147692980aea6dfd6fd3b1dd7cb23a2e63ef5b23388

See more details on using hashes here.

File details

Details for the file jupyter_ydoc-4.1.0-py3-none-any.whl.

File metadata

  • Download URL: jupyter_ydoc-4.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for jupyter_ydoc-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14c8e8a452c155d15b9d6e6de88eab0bbadf0133132c060ba795f211172794bd
MD5 e128fff1bef81236aaf92746384678c2
BLAKE2b-256 af343a1cb859835df92342bfd970cc6b4375a4e2849bcf1e7a2f0e956e54675a

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

4.1.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page