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.0.tar.gz
(2.5 MB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.2.0.tar.gz.
File metadata
- Download URL: jupyter_ydoc-0.2.0.tar.gz
- Upload date:
- Size: 2.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 262253469340100ae220ae46e0a2d26825b91a5a13be09628273a635692d8ce9 |
|
| MD5 | aeb3e68c72979278c8f549ddc5e2671d |
|
| BLAKE2b-256 | 548ddfbd3575d0d6365f1873de4df4d80a32378883393620ea8d78118d2c82b0 |
File details
Details for the file jupyter_ydoc-0.2.0-py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-0.2.0-py3-none-any.whl
- Upload date:
- Size: 6.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3e12b45966f6a48299a5c274cc8acadae1bc67bfb6f44832c5b2ff1332d74b05 |
|
| MD5 | 75fd81b4c654c573e530eebab127a03a |
|
| BLAKE2b-256 | 980a816cead4312b8007d895f793f591f9af0009ad177ef0ae89663d88208e39 |
