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

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.0a1.tar.gz (14.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.0a1-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyter_ydoc-0.3.0a1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for jupyter_ydoc-0.3.0a1.tar.gz
Algorithm Hash digest
SHA256 a95d45ac772798c8e5bad89fd23669bdf1108af644429ba24283e8cfcd3724ee
MD5 ff94365a8d79260c0f4af2eb41407705
BLAKE2b-256 31f7cde4d6a208daecf04751b3c1f302d94789d697faaf7e8987ebba47f21c59

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for jupyter_ydoc-0.3.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 21ea43900d1b0ed530c935d84517463728f2854f513e4e88bacad3e4f204bfe9
MD5 baf9303b5f0ca583f59f8a795a703570
BLAKE2b-256 4511d72a280a2c5be6d6e4d4a9cc36e0f23c9060e41eb22cdcaf8140b2859dfe

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