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 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.ydoc.YBlob'>,
#     'file': <class 'jupyter_ydoc.ydoc.YFile'>,
#     'notebook': <class 'jupyter_ydoc.ydoc.YNotebook'>,
#     'unicode': <class 'jupyter_ydoc.ydoc.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_dodument = "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-0.3.0a4.tar.gz (144.2 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-0.3.0a4-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_ydoc-0.3.0a4.tar.gz.

File metadata

  • Download URL: jupyter_ydoc-0.3.0a4.tar.gz
  • Upload date:
  • Size: 144.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for jupyter_ydoc-0.3.0a4.tar.gz
Algorithm Hash digest
SHA256 15eb6bef56b8478884a9a1a90e7a0870a3cec7838aa96401017d8e3901024a79
MD5 a8879a4e8c778431b473cdd8996a4c32
BLAKE2b-256 8e42df4237f323d57d84e7685bc9dd15ef5eaa7deb599a15bbbd16aaf88feb98

See more details on using hashes here.

File details

Details for the file jupyter_ydoc-0.3.0a4-py3-none-any.whl.

File metadata

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

File hashes

Hashes for jupyter_ydoc-0.3.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 08a8f6cb83e567a604abd7f5c77745152454369f3e93c0f6e15ea70c2c53cd0f
MD5 80855191ad66ff697ae3e44e1259af7e
BLAKE2b-256 653f8456c0d754d90e9038488ea15781c519c2710ae4d78d7644b43b0a491db9

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