Skip to main content

Document structures for collaborative editing using Ypy

Project description

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"

Project details


Release history Release notifications | RSS feed

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.2.tar.gz (955.3 kB view details)

Uploaded Source

Built Distribution

jupyter_ydoc-2.1.2-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-2.1.2.tar.gz
Algorithm Hash digest
SHA256 c989c89b4b3d963b5840957328972298d4d54834ed8f3cf7668dd613d39f2acc
MD5 8038c61ddb645c603c724c3d3bf5d5e8
BLAKE2b-256 f3b5b61275dcb8a20f878d01877b6ecea4f061756f2f20c3e1a1836c6fb56e2a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-2.1.2-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.11.10

File hashes

Hashes for jupyter_ydoc-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 04b6e2a6c113622f76cd6b1600d07d6bb032592ab875665a621addb5874d3d7f
MD5 fba72189304490789bc630038c3c6af2
BLAKE2b-256 c008d06898786555fcd928f960cbd41c4d9c97d34491757a727ecf9fce9988d9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page