Document structures for collaborative editing using Ypy
Project description
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
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
jupyter_ydoc-0.2.3.tar.gz
(65.0 kB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.2.3.tar.gz.
File metadata
- Download URL: jupyter_ydoc-0.2.3.tar.gz
- Upload date:
- Size: 65.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 98db7785215873c64d7dfcb1b741f41df11994c4b3d7e2957e004b392d6f11ea |
|
| MD5 | f0241a242f31f265942866ac642c0253 |
|
| BLAKE2b-256 | 5cc3692f0c4aa970be481e9b83a0931a18cab0be1a53837898feb9cd03711b80 |
File details
Details for the file jupyter_ydoc-0.2.3-py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-0.2.3-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3ac51abfe378c6aeb62a449e8f0241bede1205f0199b0d27429140cbba950f79 |
|
| MD5 | 02cf703fb4f58cc1a717c50cd28f01e2 |
|
| BLAKE2b-256 | 71d608a1574279d4fa161a41736c3474ddec2f8aae4b530633cc0bedc1b2a4e5 |
