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.6.tar.gz (972.6 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.6-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.3.6.tar.gz
  • Upload date:
  • Size: 972.6 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.6.tar.gz
Algorithm Hash digest
SHA256 7968529107e625475658e87eda0142bb789a723d53f336836ea25e1bf5d8ec40
MD5 ea141ee3cdc11dcb7ec0e4a901c132ce
BLAKE2b-256 a81b05a70ecb71ef81603cecea673555a73d0eaf9a51514dd7b8f139d67378db

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.3.6-py3-none-any.whl
  • Upload date:
  • Size: 13.9 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2d55c74007b46f261db16624ecd8e2e8f21d3899b60b8cd268dda1401713bb2b
MD5 7b098459a7d55d45eabc90797c722d77
BLAKE2b-256 2b4dd67079f0e7ffe2c816b7988c1e9d355f7716a7413a06b4c8862f7efae084

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.3.6

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