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.1.3.tar.gz
(4.7 kB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.1.3.tar.gz.
File metadata
- Download URL: jupyter_ydoc-0.1.3.tar.gz
- Upload date:
- Size: 4.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9bcc64f04a315d004724ac7d96013a1f694fd1c30c1ddf871e38e3446f82449f |
|
| MD5 | 28e48389ace9e6ff32a9a852692e14d9 |
|
| BLAKE2b-256 | 7d5c1e7752f2f1684385c32e4af313ab1560830da4d456fcc8057d69140991ec |
File details
Details for the file jupyter_ydoc-0.1.3-py2.py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-0.1.3-py2.py3-none-any.whl
- Upload date:
- Size: 5.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fe2739008c80ae0e7b7581e512e8d6676ab16b74db3fe5d16b3c3d7206e0cba7 |
|
| MD5 | 148dbba95add3deb025893adcc9117cc |
|
| BLAKE2b-256 | e8f5d09e5c6943ecc6de21e66fd264d9c7b2a099713438ef88352bf38833d8bc |
