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

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.13-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.13.tar.gz.

File metadata

  • Download URL: jupyter_ydoc-0.1.13.tar.gz
  • Upload date:
  • Size: 4.8 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.13.tar.gz
Algorithm Hash digest
SHA256 f066d92e82a4b5fa8e55d5e6f55fe5fc1ed98dd55b42feba3475253f864657c8
MD5 24a06e275d89214cc88cc2753b8f1cbf
BLAKE2b-256 e52cfcc5e5988b53df2fae241ff407813aa2eacf99a637d19077cb297899858f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.13-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3b4e9ccafb708ae046b0f7635804bb1ddae786e87a6d344e07d6ca1dbf2a42ee
MD5 1523e0022a59b900fffcf6b8e5e4cfc2
BLAKE2b-256 0b05a622222fca0f127d5501dfcbfb4d686aaeab336dd7eb2b39ae1f4ee055ca

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