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
Project details
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.3.0a1.tar.gz
(14.5 kB
view hashes)
Built Distribution
Close
Hashes for jupyter_ydoc-0.3.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21ea43900d1b0ed530c935d84517463728f2854f513e4e88bacad3e4f204bfe9 |
|
MD5 | baf9303b5f0ca583f59f8a795a703570 |
|
BLAKE2b-256 | 4511d72a280a2c5be6d6e4d4a9cc36e0f23c9060e41eb22cdcaf8140b2859dfe |