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.0a0.tar.gz
(2.5 MB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.3.0a0.tar.gz.
File metadata
- Download URL: jupyter_ydoc-0.3.0a0.tar.gz
- Upload date:
- Size: 2.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ecf61eb8ac2eeb0d949fb55fa290647905d3dc7442f8ab5b46f6fa187be1eabe |
|
| MD5 | e0c99a277a25a2d982dafb919cb5fd51 |
|
| BLAKE2b-256 | a6d2d36b1758e5db1e9c01cc740767903f1523b87756ec9aa7ab09812f5f8f12 |
File details
Details for the file jupyter_ydoc-0.3.0a0-py3-none-any.whl.
File metadata
- Download URL: jupyter_ydoc-0.3.0a0-py3-none-any.whl
- Upload date:
- Size: 6.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8d0d7c8c93090870f3c73ea402542c0856c40e8af9954676e9683270fdace620 |
|
| MD5 | 3b4cdf01068ff3ca905f52f6745fd36a |
|
| BLAKE2b-256 | b3f8096f4bad2b8ef04d915d4ab1ebafeb42be3898fcfee09ab5b2cfcbbb2e44 |
