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

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.17-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.17.tar.gz.

File metadata

  • Download URL: jupyter_ydoc-0.1.17.tar.gz
  • Upload date:
  • Size: 5.0 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.17.tar.gz
Algorithm Hash digest
SHA256 85a4061622f7fb3dec4ff0ebd1478d426e17bcd699fc021bac61f87277120a9e
MD5 6997d4c3307f5e0a33320725282ae3cd
BLAKE2b-256 e1f556ca907d67555f959cca1ac3a3ea54f59affea8b9dc4eab95754358716ad

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.17-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a1f9a66c9f6e4f0d993d1ecd6b326636400b516f017422132ab89dca2d027f48
MD5 9aa098759157f1a50fc4d312a995f9d6
BLAKE2b-256 d1f6a88199d5572d8e2a60b017d26e19f5dd2a7b159c1733c2f45a64a59f68ba

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