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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-2.1.3.tar.gz
  • Upload date:
  • Size: 955.4 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.3.tar.gz
Algorithm Hash digest
SHA256 80830d501f48ca1f03d3eb3452371c607ff5c5703278a2e03e2af54765d0dd74
MD5 3c3a7bcf3e27b1214b14d7fd645f5152
BLAKE2b-256 a623e36a1acf55f6791222461d8842ae38b281e44d3f0bb88c85de16d2bcbf2d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-2.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4cf405bb3b2e3c7d64a0a1b431fa1c33ffe6d510d35ecec75070a84c1bab4259
MD5 4d0f040dfe5c330f3038ebae01e16f84
BLAKE2b-256 f15ffbd36a7d5c3492f06957c26cf2b2bcbc2bc5c64b56f1b925a13700ba3655

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