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.2.4.tar.gz
(65.0 kB
view details)
Built Distribution
File details
Details for the file jupyter_ydoc-0.2.4.tar.gz
.
File metadata
- Download URL: jupyter_ydoc-0.2.4.tar.gz
- Upload date:
- Size: 65.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3f670a69135e90493ffb91d6788efe2632bf42c6cc42a25f25c2e6eddd55a0e |
|
MD5 | b4a9dd400bd35e334825117f133ba93d |
|
BLAKE2b-256 | d3a7deeb625c123f65408f686697c3bda994d91a68724c7017bf2a506fb8c766 |
File details
Details for the file jupyter_ydoc-0.2.4-py3-none-any.whl
.
File metadata
- Download URL: jupyter_ydoc-0.2.4-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1a51c73ead6f6417bec0450f53c577a66abe8d43e9c2d8a1acaf7a17259f843 |
|
MD5 | b806c7e619e51004488f4c89355d01b4 |
|
BLAKE2b-256 | 6a130871bf9df94497393e0047c17de5446eb352c673c6281efc304f902179d3 |