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.5.tar.gz
(4.6 kB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.1.5.tar.gz.
File metadata
- Download URL: jupyter_ydoc-0.1.5.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7ecf073e105765af66bb9912fd7ab10ade33b2afab7a8a9e274bf71e4b36cc3f |
|
| MD5 | 87ba8f48e716e61f8a583e90b5f08322 |
|
| BLAKE2b-256 | 6a082f7dc6aa8fd722b66a3fb14a6fb5c2e59e28b7c468f2a4f76fa949966892 |
File details
Details for the file jupyter_ydoc-0.1.5-py2.py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-0.1.5-py2.py3-none-any.whl
- Upload date:
- Size: 5.2 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1275e11e09904f8959c7284e04142193b03b7711f81b03032e8db977a5903bf5 |
|
| MD5 | 064ceed58d8fde9a57d7eff8939035e0 |
|
| BLAKE2b-256 | 00ae6d6a1376f65a361642622d51b642257d22bad7d3afbc5d8d1437794faacb |
