Document structures for collaborative editing using Ypy
Project description
jupyter_ydoc
jupyter_ydoc provides pycrdt-based data structures for various
documents used in the Jupyter ecosystem. Built-in documents include:
YBlob: a generic immutable binary document.YUnicode: a generic UTF8-encoded text document (YFileis an alias toYUnicode).YNotebook: a Jupyter notebook document.
These documents are registered via an entry point under the "jupyter_ydoc" group as "blob",
"unicode" (or "file"), and "notebook", respectively. You can access them as follows:
from jupyter_ydoc import ydocs
print(ydocs)
# {
# 'blob': <class 'jupyter_ydoc.yblob.YBlob'>,
# 'file': <class 'jupyter_ydoc.yfile.YFile'>,
# 'notebook': <class 'jupyter_ydoc.ynotebook.YNotebook'>,
# 'unicode': <class 'jupyter_ydoc.yunicode.YUnicode'>
# }
Which is just a shortcut to:
from importlib.metadata import entry_points
# for Python < 3.10, install importlib_metadata and do:
# 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 YBlob, YUnicode, YNotebook
The "jupyter_ydoc" entry point group can be populated with your own documents, e.g. by adding the
following to your package's pyproject.toml:
[project.entry-points.jupyter_ydoc]
my_document = "my_package.my_file:MyDocumentClass"
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
Built Distribution
File details
Details for the file jupyter_ydoc-3.0.0a2.tar.gz.
File metadata
- Download URL: jupyter_ydoc-3.0.0a2.tar.gz
- Upload date:
- Size: 955.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cabc17e9fbd79bee27fd94f84af5194a857b04d4074a0813eea0bd5adce1e835 |
|
| MD5 | 6eba209c7555df0d6428cbf139fd24d4 |
|
| BLAKE2b-256 | e25f58709bc6e3abd47fcc6852d30f3d518628b0a0c2833c30cd944708adfe57 |
File details
Details for the file jupyter_ydoc-3.0.0a2-py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-3.0.0a2-py3-none-any.whl
- Upload date:
- Size: 10.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e90c99540b47d5dae92da93215fc462720ced02d22f47146f5415b70cd3630b6 |
|
| MD5 | 7284707cbc498692d84120a251da2bb1 |
|
| BLAKE2b-256 | 6d70b35f8de8b12e0ce5d614b73fb914e6980078ef5b1c81cfeeae41ec238e76 |
