Skip to content

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

Merged
transfix merged 1 commit into
masterfrom
docs-nmdcpb-scope-note
Jul 4, 2026
Merged

transfix merged 1 commit into
masterfrom
docs-nmdcpb-scope-note

Conversation

@transfix

@transfix transfix commented Jul 3, 2026

Copy link
Copy Markdown
Owner

Summary

Clarifies the scope of the NMDCpb section in the README (the PyPI long description).

eiskaltdcpp-py currently exposes only the low-level NMDCpb envelope primitives (send_pb / send_pb_routed + the pb_message event). It does not generate protobuf types for Python and has no high-level helpers for the E2E-encrypted PM, hub-relay, media-share, or channel extensions. The previous wording could imply those higher-level features were available here.

Changes

  • Add a scope note making explicit that this package is low-level transport only.
  • Cross-reference the ready-made high-level client — verlihub.client.nmdcpb.NMDCpbClient in the companion verlihub-py package — for users who want ergonomic E2EPM / relay / media / channels today.
  • Note that high-level wrappers for eiskaltdcpp-py are planned.

Docs-only change.

eiskaltdcpp-py only exposes the low-level NMDCpb envelope primitives
(send_pb/send_pb_routed + pb_message event); it has no protobuf types or
high-level E2EPM/relay/media/channel helpers. Add a scope note making
this explicit and cross-reference verlihub.client.nmdcpb.NMDCpbClient in
the verlihub-py package as the ready-made high-level client, noting that
eiskaltdcpp-py high-level wrappers are planned.
@transfix
transfix merged commit 6adacb0 into master Jul 4, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant