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.2.tar.gz
(4.7 kB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.1.2.tar.gz.
File metadata
- Download URL: jupyter_ydoc-0.1.2.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 | e09faa145bedbca714e06b22cfc4f7eab9f176d20e2ed8c80fd96e7e55080e6c |
|
| MD5 | 132bbe3dd84ec6af45de327be869a0eb |
|
| BLAKE2b-256 | b1c52cadc71c9167a41ea12d3920b898acd27ad733a53619daf892e26f66308a |
File details
Details for the file jupyter_ydoc-0.1.2-py2.py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-0.1.2-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 | 918679eb31b87a07c4d575fdf3bb11087212865292f9d40b7d6f14b854db908d |
|
| MD5 | 56a5717f573393f9c246e1f4be5bb668 |
|
| BLAKE2b-256 | f35d297cedf5bf57f48b29985aada7b7b89e0a12e134ab6dca0332d60eeb0066 |
