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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-1.1.0.tar.gz
Algorithm Hash digest
SHA256 6e248c5688420c60a65e4e70d371c234dec2fc8643be829a483d49b128fe6ed6
MD5 c9f8305f9e53d3d96ef10771bd675eba
BLAKE2b-256 067536fb55ec9503efec5a2fcc4373102dca4dc0d6a12fe94e747415f4d06988

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-1.1.0-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.11.5

File hashes

Hashes for jupyter_ydoc-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b377cbda381ac374c6af6d10ce0485f4370ae8c3c9485406af4547c4dd284750
MD5 5e5e724a01a8f1d4bd52b48ea7886106
BLAKE2b-256 d1814286bb6e6652b0022984fe4057a149c036f28da073089272fee9900c90df

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