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

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.14-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.1.14.tar.gz
  • Upload date:
  • Size: 4.7 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.14.tar.gz
Algorithm Hash digest
SHA256 2fdbbe6c9a095ddd1997480af1a72735f12aa754fe0958dfdb0e2765ca0086ef
MD5 f81e4eeb6e7fb1c66518892d8122a4d2
BLAKE2b-256 377c0fedfba39d596dfc539c5ba3207fd6b4d7f98fc474443e33108be0c27199

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 211bcf62ea95da8a58872281b56fc51ff243d38087bc45d4db99b1319d6a4f58
MD5 d1e492c4981694193d6e89ef0cf9dfc7
BLAKE2b-256 c2b966f6e1cce875d23ac8d72723189ab1b1d3ec63a96b8dae78a15e95a66d94

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