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 sys
import jupyter_ydoc

# See compatibility note on `group` keyword in https://docs.python.org/3/library/importlib.metadata.html#entry-points
if sys.version_info < (3, 10):
    from importlib_metadata import entry_points
else:
    from importlib.metadata import entry_points

ydocs = {ep.name: ep.load() for ep in 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 document, 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.1.1.tar.gz (4.8 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.1.1-py2.py3-none-any.whl (5.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-0.1.1.tar.gz
Algorithm Hash digest
SHA256 cfa9b2c24d96a4f25c38095ecc9054a65c59406d6ec92351d1f34ab37deea7d8
MD5 31f98946a72cf3d1e6972a0243d8e129
BLAKE2b-256 466650cb87bde37f6e673a20d297c2fcfe56c5c9e011f13a62949ecd0904cb20

See more details on using hashes here.

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.1.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jupyter_ydoc-0.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1ee43a530513e4c219c593527a9bd01a88b1efff94f72089659e14ba0473c446
MD5 cd2faff77572a94a462e7ac603bd99a8
BLAKE2b-256 d59326334fd941299d5e219a8fcaa97f699dac16f5033e5e77cae3a4827d56c6

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.1

Supported by

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