Skip to main content

Build Status Code style: black PyPI npm (scoped)

jupyter_ydoc

jupyter_ydoc provides Ypy-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:

import pkg_resources

ydocs = {ep.name: ep.load() for ep in pkg_resources.iter_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-2.1.4.tar.gz (955.5 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-2.1.4-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-2.1.4.tar.gz
Algorithm Hash digest
SHA256 7b80839d7fbb0ec506cc6619221a172920e50258e6ddb2c6da4654177df9e2fc
MD5 39d8d4a68e1dae82b9640772a1fdd545
BLAKE2b-256 5f6f737b201b6b253d63e4bb734fa4ae65ac9f8806d7fcc2d2a900efa7fe9d22

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-2.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8a4d47ea33b95215a60bea8b2bd1506c509a0dd68cd965dd1db7946aa2c6a6e3
MD5 3459c6bde9e6080b29949580637e88bf
BLAKE2b-256 2f987e1063569d2f50bb065aa896c0071fe7b56fc2339ad79849f62598a43427

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