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

Uploaded Source

Built Distribution

jupyter_ydoc-0.2.5-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.2.5.tar.gz
  • Upload date:
  • Size: 64.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for jupyter_ydoc-0.2.5.tar.gz
Algorithm Hash digest
SHA256 5a02ca7449f0d875f73e8cb8efdf695dddef15a8e71378b1f4eda6b7c90f5382
MD5 04416183abe932d2240c2aa0eae1b0f6
BLAKE2b-256 01114bc1c63aad398095171848d66940f7cf057cc7c1d04ecbeb4119a4a2b22d

See more details on using hashes here.

File details

Details for the file jupyter_ydoc-0.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_ydoc-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5759170f112c70320a84217dd98d287699076ae65a7f88d458d57940a9f2b882
MD5 e7f9f0d87e1fbaf538651e69fc6d4ff6
BLAKE2b-256 e13666e6cb851a43c95f00f47b36d2cb3e17d37f862449dc8258b2c04f02544b

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