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.1.13.tar.gz
(4.8 kB
view hashes)
Built Distribution
Close
Hashes for jupyter_ydoc-0.1.13-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3b4e9ccafb708ae046b0f7635804bb1ddae786e87a6d344e07d6ca1dbf2a42ee |
|
MD5 | 1523e0022a59b900fffcf6b8e5e4cfc2 |
|
BLAKE2b-256 | 0b05a622222fca0f127d5501dfcbfb4d686aaeab336dd7eb2b39ae1f4ee055ca |