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

3.0.1

Nov 18, 2024

3.0.0

Oct 29, 2024

3.0.0b0 pre-release

Oct 18, 2024

3.0.0a10 pre-release

Oct 17, 2024

3.0.0a9 pre-release

Oct 10, 2024

3.0.0a8 pre-release

Sep 26, 2024

3.0.0a7 pre-release

Sep 18, 2024

3.0.0a6 pre-release

Aug 30, 2024

3.0.0a5 pre-release

Aug 23, 2024

3.0.0a4 pre-release

Aug 19, 2024

3.0.0a3 pre-release

Aug 7, 2024

3.0.0a2 pre-release

Jul 12, 2024

3.0.0a1 pre-release

Jul 5, 2024

3.0.0a0 pre-release

Jun 26, 2024

2.1.3

Oct 18, 2024

2.1.2

Oct 10, 2024

2.1.1

Jul 10, 2024

2.1.0

Jul 10, 2024

2.0.1

Dec 26, 2023

2.0.0

Dec 8, 2023

1.1.1

Sep 29, 2023

1.1.0

Sep 21, 2023

1.1.0a0 pre-release

Jun 29, 2023

1.0.2

Apr 14, 2023

1.0.1

Apr 11, 2023

1.0.0

Mar 29, 2023

0.3.4

Feb 22, 2023

0.3.3

Feb 21, 2023

0.3.2

Feb 20, 2023

0.3.1

Jan 26, 2023

0.3.0

Jan 24, 2023

0.3.0a6 pre-release

Jan 19, 2023

0.3.0a5 pre-release

Jan 17, 2023

0.3.0a4 pre-release

Jan 14, 2023

0.3.0a3 pre-release

Jan 13, 2023

0.3.0a2 pre-release

Jan 5, 2023

0.3.0a1 pre-release

Oct 26, 2022

0.3.0a0 pre-release

Sep 26, 2022

0.2.5

Jul 18, 2023

0.2.4

Apr 12, 2023

0.2.3

Mar 10, 2023

0.2.2

Oct 26, 2022

0.2.1

Sep 29, 2022

0.2.0

Sep 26, 2022

0.1.17

Aug 1, 2022

0.1.16

Jul 27, 2022

0.1.15

Jul 27, 2022

0.1.14

Jul 26, 2022

0.1.13

Jul 4, 2022

0.1.12

Jul 1, 2022

0.1.11

Jun 9, 2022

0.1.10

May 19, 2022

0.1.9

May 19, 2022

0.1.8

May 12, 2022

This version

0.1.7

May 11, 2022

0.1.6

May 11, 2022

0.1.5

May 10, 2022

0.1.4

May 9, 2022

0.1.3

May 5, 2022

0.1.2

May 5, 2022

0.1.1

May 4, 2022

0.1.0

May 2, 2022

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.7.tar.gz (4.6 kB view details)

Uploaded May 11, 2022 Source

Built Distribution

jupyter_ydoc-0.1.7-py2.py3-none-any.whl (5.2 kB view details)

Uploaded May 11, 2022 Python 2 Python 3

File details

Details for the file jupyter_ydoc-0.1.7.tar.gz.

File metadata

Download URL: jupyter_ydoc-0.1.7.tar.gz
Upload date: May 11, 2022
Size: 4.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jupyter_ydoc-0.1.7.tar.gz
Algorithm	Hash digest
SHA256	`47ad189e7ff0737bd5b5faa2add0929b16a91fdffbd8f5394618e2bc93f8934e`
MD5	`ef054a748f710295bebc7fd7b39f34ae`
BLAKE2b-256	`f8336428579d64c1a09315616746abc262da1718a6a7323f49af3d9f1697fb28`

See more details on using hashes here.

File details

Details for the file jupyter_ydoc-0.1.7-py2.py3-none-any.whl.

File metadata

Download URL: jupyter_ydoc-0.1.7-py2.py3-none-any.whl
Upload date: May 11, 2022
Size: 5.2 kB
Tags: Python 2, Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for jupyter_ydoc-0.1.7-py2.py3-none-any.whl
Algorithm	Hash digest
SHA256	`207323cfb72d667caa5142571c860729e03ecac6657249119c8a1ee590824cf3`
MD5	`a9366d8bea04a8efacdd7007b02677d1`
BLAKE2b-256	`ac50eb9fb5c4ea65d28a5cc557bfea04cd2364484be93e6eba00909f8da466e4`