Skip to main content

Document structures for collaborative editing using Ypy

Project description

Build Status Code style: black

jupyter_ydoc

jupyter_ydoc provides Ypy-based data structures for various documents used in the Jupyter ecosystem. Built-in documents include:

  • YFile: a generic text document.
  • YNotebook: a Jupyter notebook document.

These documents are registered via an entry point under the "jupyter_ydoc" group as "file" and "notebook", respectively. You can access them as follows:

from jupyter_ydoc import ydocs

print(ydocs)
# {'file': <class 'jupyter_ydoc.ydoc.YFile'>, 'notebook': <class 'jupyter_ydoc.ydoc.YNotebook'>}

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 YFile, YNotebook

The "jupyter_ydoc" entry point group can be populated with your own documents, e.g. by adding the following to your package's setup.cfg:

[options.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-0.1.8.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.8-py2.py3-none-any.whl (5.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.1.8.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jupyter_ydoc-0.1.8.tar.gz
Algorithm Hash digest
SHA256 1b403b2ef8503e2528c33af8fbcdd3731167f1f850a66f4a33e0ae7a0d25ed6f
MD5 f40eec366968808918212dd07a75892b
BLAKE2b-256 065fcb9798eb6d292d09d1292870ada7ea3fe2d2bb68919505e7215a2fa14933

See more details on using hashes here.

File details

Details for the file jupyter_ydoc-0.1.8-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 eb9c77970679db7946c83cf4f7ada9112a6ebf812752774961a89dd8a96ff850
MD5 a35e00d13d77174a9b7a90435e085b36
BLAKE2b-256 b3274d98166d18566127e95d7e4e693b76898e9f61782944d36375ab674601fb

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