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.3.tar.gz (971.1 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.3-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.3.3.tar.gz
  • Upload date:
  • Size: 971.1 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.3.tar.gz
Algorithm Hash digest
SHA256 01b3a3ba57a5347ad9f9df6b298571affded3253f5fe90e19453c2fc49c100b4
MD5 e350ba75b479eaf54da4d980ccf7c1a1
BLAKE2b-256 7ab0243a6c18549f2f63cc6bbd2de748d4682c345f738c26426128923f90f2bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.3.3-py3-none-any.whl
  • Upload date:
  • Size: 13.1 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 48122544b33d0cb4e7eeadd775074d79b79a66d356ae13b4f1f05d81178ad4d7
MD5 9369f6f2045e2b57a3db517957c19a37
BLAKE2b-256 3cb4e3360c212a8deb13b533b309ae462bd0d6ff85fb60ceec495914cc8c9d84

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

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