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-1.0.2.tar.gz (954.4 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-1.0.2-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-1.0.2.tar.gz
  • Upload date:
  • Size: 954.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for jupyter_ydoc-1.0.2.tar.gz
Algorithm Hash digest
SHA256 0f95bede3f1e081e07d5c57c03c658e3a5247e0ef18889074fbefa20dd3eca53
MD5 7effaed90512227940896ba1446ed02b
BLAKE2b-256 f5327be05fc28fc1fdad7f616b6b3f9ad02dc099cad39084f9f66f45b3b26d69

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for jupyter_ydoc-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 980661ebe8d8b79401c48707dce3a2a90bc7f2bdfd8fbdb16461c13561a088c7
MD5 8689a1a55d39bdfb6be04ef5762ceb60
BLAKE2b-256 01ec6b654883d39ac92f96a29bd2ff20daec027aeea62189fe3468014055ea47

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