Skip to content

Standardize README and refresh DEVELOPER guide (CLEN-3802) - #237

Closed
jguz-pubnub wants to merge 1 commit into
masterfrom
CLEN-3802-standardize-readme
Closed

jguz-pubnub wants to merge 1 commit into
masterfrom
CLEN-3802-standardize-readme

Conversation

@jguz-pubnub

Copy link
Copy Markdown
Contributor

Summary

  • Rewrite README.md using the standard PubNub SDK README template (CLEN-3789 / CLEN-3802).
  • Rewrite DEVELOPER.md: current Python versions (3.9–3.13), setup, tests, linting, call styles, daemon mode.

Deviations from CLEN-3802

  • Quickstart example differs from the story's snippet: it publishes from the main thread after the connected event, uses no global, and a try/finally always unsubscribes, removes the listener and calls pubnub.stop().
  • License name and contribution text use the story's values; the LICENSE file title is "PubNub Software Development Kit License Agreement".

Testing

  • Ran the README Quickstart against a real keyset on Python 3.13; it printed Hello world and exited 0.
  • Not yet verified: Python 3.9, failure paths, and that all documentation links resolve.

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 deleted the CLEN-3802-standardize-readme branch October 19, 2026 10: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.

1 participant