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

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.4-py2.py3-none-any.whl (5.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 cad0caa69b110435ccae8c3215dab6bbf268f19e80fd3a01bbb6e05523fbf920
MD5 61b2b0ff2ac545de715d4f3b50414b6f
BLAKE2b-256 ab736ba9af7910e65c8ade5d52ee04f3aabd8f0c5df0df4c2d780a35204c60d0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7d95d4bdc11696da8259522617e728da69d94442d3841e16ad15027f91e6a172
MD5 2381d7590e51563b34309b9234f0ddde
BLAKE2b-256 f202b41491936b784f7651053cd4d23195b96353b20649ec38c54ad53e722475

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