Skip to main content

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

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyter_ydoc-0.2.1-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-0.2.1.tar.gz
Algorithm Hash digest
SHA256 f688c69b2b7ee21671840cfa424e98f22822e695bceb6e6a7d02d08176eee0aa
MD5 18fcbeb3d73058b0a8955b989d13d80b
BLAKE2b-256 a26373893cbecce0259c814a9e9831d503d9aad09133cd7ed68159d31cfc715a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for jupyter_ydoc-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a8f91d121a85b4aeed138299e70f0620360170b16e6de71865f3969d6471bb20
MD5 861b254292995e871b507f2a91a493e2
BLAKE2b-256 850aa4cfcf2d930b2587061cbcdc5fd5d29f5e62dcfefa19ad98c626c323d7e7

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page