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.0a8.tar.gz (956.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.0.0a8-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-3.0.0a8.tar.gz
Algorithm Hash digest
SHA256 6cb09cbf0b84c7998bcbab7993c6db215e8724819c81af1595778997ced83544
MD5 1c97b8120bc2d7ddcf4ed8d49364b2ce
BLAKE2b-256 40654a87e146f6d2d4a223a43ac694bf014434ea5d5913595b5a0cb3c6730600

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.0.0a8-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.10

File hashes

Hashes for jupyter_ydoc-3.0.0a8-py3-none-any.whl
Algorithm Hash digest
SHA256 3ba634e676098e7afe4de421613d92c412f231d8b23ff177d32154b5df3295f4
MD5 330961472ef78400bb6fa5592cf9e031
BLAKE2b-256 a2762d1802709bca21a266fd506743206c36afe6e05562f9c226a793ca8474d7

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