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.0a4.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.0a4-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.0.0a4.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.0a4.tar.gz
Algorithm Hash digest
SHA256 cce12407e34aaba674ee7f1b8a1687f032875021301f9e18b5cd280c395152de
MD5 660c0c80f4012684a1baac0cb6dcf37a
BLAKE2b-256 dd288c6a41ff0963abec456dbf9b7a5ac57d9d4716f8f012decd4b071d886a36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.0.0a4-py3-none-any.whl
  • Upload date:
  • Size: 10.8 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.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 ace756768b5ead6f29cd33362a4ef0967d4e2ecd9ee7ce0356dda2331b2d55d6
MD5 25f1a8d63ed79e9fe373b45213d4bddb
BLAKE2b-256 71a073573d7cc113f5a06955c437995f4035c7ece1910ee434008bcbeca0cfbf

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 Pingdom Monitoring Sentry Error logging StatusPage Status page