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

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.15-py2.py3-none-any.whl (5.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.1.15.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for jupyter_ydoc-0.1.15.tar.gz
Algorithm Hash digest
SHA256 f0f1918371e2bd97c004c8a238a2c74d5ede14a7727e875c77a98ef491d52278
MD5 4ab91ca0b3e5f965f705ab3d66da67ba
BLAKE2b-256 83e95a0c1ece5b847a9ce8937f1e5651da954c7d8bf4a0e262f31b8cbaea6bdc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.15-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1bbc76252b858781bfc04c886f6ec1661700ccc2d39b63cba01b93ccf8853508
MD5 c0625945ff5d5ce627f837c3bcfad1dc
BLAKE2b-256 473b978b2d1b99e1194b0df2b62471e9c92654e422bde343edc46df7adb79ee9

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