Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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
# for Python < 3.10, install importlib_metadata and do:
# 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.0.0a6.tar.gz (955.9 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.0.0a6-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_ydoc-3.0.0a6.tar.gz.

File metadata

  • Download URL: jupyter_ydoc-3.0.0a6.tar.gz
  • Upload date:
  • Size: 955.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for jupyter_ydoc-3.0.0a6.tar.gz
Algorithm Hash digest
SHA256 f7493aa792e112a81107b4f5da85f8a8a48d995068a2988844a3da709233664c
MD5 51a2edd5d7a783963908910d48c5c76a
BLAKE2b-256 ff60ddac520c37e2d20bc3c8c354889914c05e0f180e9af0c8ca8ccd9b235726

See more details on using hashes here.

File details

Details for the file jupyter_ydoc-3.0.0a6-py3-none-any.whl.

File metadata

  • Download URL: jupyter_ydoc-3.0.0a6-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.9

File hashes

Hashes for jupyter_ydoc-3.0.0a6-py3-none-any.whl
Algorithm Hash digest
SHA256 c6351295a76a066ff26a7a29203e0b5f8d302ee746881de8ade46b201e478225
MD5 6b4c7a16f4788317d1a2b3055f1bef29
BLAKE2b-256 27cc268b63d1d7538e88cdc8f301088d9708cf17d912fdacbc962b035ed362c0

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