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-3.3.4.tar.gz (972.0 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-3.3.4-py3-none-any.whl (13.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-3.3.4.tar.gz
Algorithm Hash digest
SHA256 b35f9cd0048d69860a3665463006de921b07a340562aabd6e82518db5f69ee1b
MD5 9ec839a0bdc66a1e7dfdc96057b6dec4
BLAKE2b-256 b8acb1bbce06435c2276834e4ac45a9a033af272fbd319894751484dbe5e8b8b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-3.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 bc20d9829dfd81acf063e0049ef0ebf7ea0096e0688fbfe6eb807ca1c03bc144
MD5 2e47e2da242b3067159db8435d2f1fcb
BLAKE2b-256 c3b60e7eb91e3ab61c451729e0f07d97e449ee87c17eef0377ed2524d765efbf

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.3.4

Supported by

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