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

Uploaded Source

Built Distribution

jupyter_ydoc-0.2.2-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-0.2.2.tar.gz
Algorithm Hash digest
SHA256 3163bd4745eedd46d4bba6df52ab26be3c5c44c3a8aaf247635062486ea8f84f
MD5 b6ecd740a7c526d25d3308df99a3ffcb
BLAKE2b-256 d96d33b93c10cc77c73f3a118479ae37662387bbff3e37af09bf02684effa138

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 596a9ae5986b59f8776c42430b5ad516405963574078ab801781933c9690be93
MD5 93a0a0f2a583afd27136b37b9776b95e
BLAKE2b-256 0c40f1fd1f933779cca1fba5b223a2d62dc853766f3154dad3c61e1846f5ff87

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