Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Build Status Code style: black PyPI npm (scoped)

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.3.0a3.tar.gz (147.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.3.0a3-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_ydoc-0.3.0a3.tar.gz.

File metadata

  • Download URL: jupyter_ydoc-0.3.0a3.tar.gz
  • Upload date:
  • Size: 147.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for jupyter_ydoc-0.3.0a3.tar.gz
Algorithm Hash digest
SHA256 5b6bfdfb8cee2f5eaccec8e3c8cf57e47e425cbbb8f18bed97ba55ffd949bb3a
MD5 754151541c619144cd8e91f9315deb93
BLAKE2b-256 519222972c8b47bc5a327ddd4df10cb046103e9b00fcd702069454d0d8fe1faa

See more details on using hashes here.

File details

Details for the file jupyter_ydoc-0.3.0a3-py3-none-any.whl.

File metadata

  • Download URL: jupyter_ydoc-0.3.0a3-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for jupyter_ydoc-0.3.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 722e450f93b9ce7735db51e5302bd12c506c238383a25f8445196ee1cf9aea1c
MD5 69ba85cd47fa03724d01104f049c5cc2
BLAKE2b-256 666950762c58f2a142c0bc5f5ce62603eef7924ae9a3ac314344102a175b8815

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