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.0a0.tar.gz (955.2 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.0a0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-3.0.0a0.tar.gz
Algorithm Hash digest
SHA256 4586cdba80238e8f4c17d3d3e7be7937a58ad9cea44052511de82085038a3438
MD5 6ffbd715be2ae37d5e89241fb94468d3
BLAKE2b-256 7abf0803cc819cd7b55fdd808942df9a0c8258c31d637c3e5133a4c38f8473e5

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-3.0.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f388aa4d8d66c32c832aba6baeeb0d221f8f888990b96d4fcca2445dd7223c6
MD5 a25c450c70d9db4e1109315e4e575fa1
BLAKE2b-256 2c2d6cae1e2a49da23a9c56942e60966dedd93c8b1e3cbec3fdec777a8c14e8c

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