Skip to content

Standardize README and refresh DEVELOPER guide - #238

Merged
jguz-pubnub merged 4 commits into
masterfrom
standardize-readme
Oct 21, 2026
Merged

jguz-pubnub merged 4 commits into
masterfrom
standardize-readme

Conversation

@jguz-pubnub

@jguz-pubnub jguz-pubnub commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

No description provided.

Rewrite README.md to the standard PubNub SDK template and update DEVELOPER.md with current Python versions, test, lint and call-style guidance.
@pubnub-snyk-universal-prd

pubnub-snyk-universal-prd Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@jguz-pubnub jguz-pubnub changed the title Standardize README and refresh DEVELOPER guide (CLEN-3802) Standardize README and refresh DEVELOPER guide Oct 19, 2026

@parfeon parfeon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good but I think demo can be improved to use new subscription approach through subscription and subscription set. Can you please verify example and use if it fits?

Comment thread README.md
Comment on lines +84 to +97
try:
pubnub.subscribe().channels("hello_world").execute()

if not listener.connected.wait(timeout=10):
raise TimeoutError("Timed out waiting for the subscription to connect")

pubnub.publish().channel("hello_world").message("Hello world").sync()

if not listener.received.wait(timeout=10):
raise TimeoutError("Timed out waiting for the message")
finally:
pubnub.unsubscribe().channels("hello_world").execute()
pubnub.remove_listener(listener)
pubnub.stop()

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What it we would use newer approach for demo which utilize Subscription / SubscriptionSet?

Suggested change
try:
pubnub.subscribe().channels("hello_world").execute()
if not listener.connected.wait(timeout=10):
raise TimeoutError("Timed out waiting for the subscription to connect")
pubnub.publish().channel("hello_world").message("Hello world").sync()
if not listener.received.wait(timeout=10):
raise TimeoutError("Timed out waiting for the message")
finally:
pubnub.unsubscribe().channels("hello_world").execute()
pubnub.remove_listener(listener)
pubnub.stop()
subscription = pubnub.channels("hello_world").subscription()
try:
subscription.subscribe()
if not listener.connected.wait(timeout=10):
raise TimeoutError("Timed out waiting for the subscription to connect")
pubnub.publish().channel("hello_world").message("Hello world").sync()
if not listener.received.wait(timeout=10):
raise TimeoutError("Timed out waiting for the message")
finally:
subscription.unsubscribe()
pubnub.remove_listener(listener)
pubnub.stop()

Will this work for us?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I will use an example with Subscription

@parfeon parfeon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks good but I think demo can be improved to use new subscription approach through subscription and subscription set. Can you please verify example and use if it fits?

@jguz-pubnub
jguz-pubnub merged commit 4b3a54a into master Oct 21, 2026
20 of 27 checks passed
@jguz-pubnub
jguz-pubnub deleted the standardize-readme branch October 21, 2026 15:29
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.

2 participants