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
# 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.2.tar.gz (956.8 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.2-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.0.2.tar.gz
  • Upload date:
  • Size: 956.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for jupyter_ydoc-3.0.2.tar.gz
Algorithm Hash digest
SHA256 d5f1d5bc3ec9579e587469496cd33d6f2a69e18e74329e130c231410ba1c31d0
MD5 b9f534fbe330de95cd1e9da7c2a22035
BLAKE2b-256 a87bbcd792dbbb6ab6d2db7fb20d924803d6facb340dc66501344d0882c7454d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 11.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.7

File hashes

Hashes for jupyter_ydoc-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 76ed83ecd95e6eae1c21941235a6e4c7daff9639341821b8668f5060719eda61
MD5 81b0107f7e7826af9bf4857293c2237b
BLAKE2b-256 097dcda7ac40a2ea172716354b2c451327cf0ca0060f000b6cef6d0486e3b083

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.0.2

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