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.3.0a2.tar.gz
(81.8 kB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.3.0a2.tar.gz.
File metadata
- Download URL: jupyter_ydoc-0.3.0a2.tar.gz
- Upload date:
- Size: 81.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 758dec1791e4fd809cfa633183037f126c78d3d7dab8f7664bcc564d8799314a |
|
| MD5 | d80a2ea0f1c8cc737446da1ebd4815ba |
|
| BLAKE2b-256 | 8534418542a4672c5a25266672d726e3bd0bfd8025e9cad72f056b5ed9ee7826 |
File details
Details for the file jupyter_ydoc-0.3.0a2-py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-0.3.0a2-py3-none-any.whl
- Upload date:
- Size: 7.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a25870fa4feb8bd82b6111d0915cb0df32eabb4569169ffd51b282164cb517eb |
|
| MD5 | d78d1cfa0ff8ccf3914f950f7f3217c6 |
|
| BLAKE2b-256 | 3c41314af0777e780ffd247d2c8fe8a9db988e943008866a0fc26db624a6a99a |
