Skip to content

docs: clarify NMDCpb scope + cross-reference verlihub-py client #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
transfix merged 1 commit into from
Jul 4, 2026
Merged

docs: clarify NMDCpb scope + cross-reference verlihub-py client #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,19 @@ The same API is available on `AsyncDCClient`, which additionally provides
`await client.wait_pb_message(cmd=..., from_nick=..., timeout=...)` for
awaiting a specific inbound protobuf message.

> **Scope — low-level transport only.** This package currently exposes only
> the raw envelope primitives above (`$PB` / `$PBR` broadcast and routing plus
> the `pb_message` event). Protobuf message types are **not** yet generated for
> Python, and there are **no** high-level helpers for the E2E-encrypted PM,
> hub-relay, media-share, or channel extensions — you must build and parse
> `PbEnvelope` payloads yourself.
>
> A ready-made **high-level NMDCpb client** (ergonomic E2EPM, hub-relayed
> transfers, media sharing, and channels, with importable protobuf types) is
> available today in the companion **[verlihub-py](https://pypi.org/project/verlihub-py/)**
> package as `verlihub.client.nmdcpb.NMDCpbClient`. High-level wrappers for
> eiskaltdcpp-py are planned.

### Event types

| Event | Arguments |
Expand Down
Loading