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

Uploaded Source

Built Distribution

jupyter_ydoc-0.1.11-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.11.tar.gz.

File metadata

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

File hashes

Hashes for jupyter_ydoc-0.1.11.tar.gz
Algorithm Hash digest
SHA256 1ebdb47d5bd78f11da8bfd72ad6c232d996e0600dc6cb744e13eb1e0ddefcc8d
MD5 a25db5dd586373d957752af19eae8741
BLAKE2b-256 2c20028cb47566077d446428c6c2e2cbc22c150d2884cfc6ac3875fe5819ad95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for jupyter_ydoc-0.1.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e36fa69969de81596e6ac8b9e30685fb3167506473378d5e9778201b1cd7eed7
MD5 0ad592709d249584f469e631f4d38004
BLAKE2b-256 bf0bf481b70049c8cd3ac611450399321c19c16457ffbf67d5c6e3e1d35d9e2d

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