Optional shared pointers and hover outlines for spaday. Use ordinary HTML targets or supply geometry from a virtualized component.
Install
pip install "spaday-collab[examples]"
Usage
from spaday import SetField, element, event_value
from spaday_collab import Pointers
page = element(
"main",
element("section", "Review this section", **{"data-collab-target": "review"}),
Pointers()
.bind("peers", "remote_pointers")
.on("pointer-change", SetField("local_pointer", event_value("pointer"))),
)
A pointer is {target, x, y} with coordinates between zero and one. Remote entries are {peer, pointer, label?, color?}. The application maps scoped awareness into this list and chooses labels and colors. The included example uses Spaday's Wire.awareness and one transports connection for both shared data and pointers.
The browser module also exports connectPointers, domTargets, and elementGeometry. These work without the Pointers renderer or a transports connection.
Documentation
- Tutorial: run two users against a shared note.
- How-to guides: connect awareness, adapt geometry, and replace the display.
- Reference: Python component, browser API, and tokens.
- Explanation: ownership and lifecycle boundaries.
Browser Examples
Open the Pyodide gallery. Python creates real Pointers components with explicitly labeled sample peers. This single-browser preview has no shared server; use the local example for real collaboration.
Run the examples locally
pip install "spaday-collab[examples]"
python -m spaday_collab.example
Open http://127.0.0.1:8044/ and http://127.0.0.1:8044/bob in separate browsers. Move over the note or review section to see pointers, then edit the shared note. Demo identities are selected by URL; production applications must authenticate users and assign permissions on the server.
From a checkout, run make develop, make build, and make test. make pyodide-example builds dist/lite; make test-pyodide-example checks that preview in Chromium.
Metadata
Release files for spaday-collab 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| spaday_collab-0.1.0.tar.gz | 65.2 kB | Without provenance | Details for spaday_collab-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| spaday_collab-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for spaday_collab-0.1.0-py3-none-any.whl |
Total release size: 89.9 kB
Release files / spaday_collab-0.1.0.tar.gz
| Download URL | spaday_collab-0.1.0.tar.gz |
|---|---|
| Size | 65.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fd810c029ac71963b72fff69677072a2ee51930375b68cf5fae31fd3882a4663
|
|
BLAKE2b-256 checksum How to use checksums |
8faae24895065b8dc9d3e2e6cb71ae59e0aa42f67fb44bdf6b7bdef98dd0bba8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Release files / spaday_collab-0.1.0-py3-none-any.whl
| Download URL | spaday_collab-0.1.0-py3-none-any.whl |
|---|---|
| Size | 24.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e41e8a42a1ff02296063a87e4dd746c5d4b0a0b703855fd7713931bfe36b9e4b
|
|
BLAKE2b-256 checksum How to use checksums |
e902eea6bdce9d3cb0c1a5fd931923d7801da8b5ddbf1729c4504fd08232b96c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.15
|
Security for spaday-collab 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.