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

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.12-py2.py3-none-any.whl (5.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-0.1.12.tar.gz
Algorithm Hash digest
SHA256 91ce990611d6a7e29985c6c749736dda219ef9306ee8bb5ecb21e85d40f7e085
MD5 cc8c6fedcb43ddbd5545da3d7165db8d
BLAKE2b-256 761433903bf9f553c57647a0700e5ae4e733ac959a42496a8f2748df487d81c5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.12-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 04c0963c45a67a6c9f40f24004ec665084a9a5f4e8ffa8e268d21b1f785680eb
MD5 4d8b89f49657669bf6568b877f1ed99f
BLAKE2b-256 760694d99258130f25432ac9c8dd8960bde1a3a4344696ec97b6bd7d2da1130f

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