You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rewrites the README for the 4.0 ably-pubsub-server package, in the same structure as the other
Ably Pub/Sub READMEs: one-line requirements, the migration table after the quick start, and no text
that repeats the samples. Only README.md changes.
What changed
Overview: the server-only note and a Package / Use it for / Entry point table.
Requirements: one line, Python 3.8 or later, matching requires-python.
Installation: pip install ably-pubsub-server. One sentence names the crypto and vcdiff extras.
Quick start: the realtime and async HTTP publish samples, the server-client [!IMPORTANT] note linking to the docs on token authentication, a token request served from a FastAPI endpoint at /ably-auth that device SDKs use as their authUrl, plus two sentences on the event loop. The sync client is one sentence.
Migrating from 3.x: a top-level section after Quick start, with a 3.x to 4.0 table and a link to UPDATING.md.
Common configuration and Live Objects: shorter prose. The samples are unchanged.
Platform notes: removed. Its gotchas now sit in the Quick start.
API key: server samples read it from the ABLY_API_KEY environment variable.
Links: repository files use absolute GitHub URLs.
How it was validated
Every claim was checked against the source on main: package name, extras, requires-python, the client factories, options and the LiveObjects API.
Every sample compiles with py_compile.
The /ably-auth endpoint sample runs under FastAPI's test client against the main sources. With a dummy key, it returns a token request with Content-Type: application/json, and the lifespan closes the client on shutdown.
Relative links and the UPDATING.md anchors exist at main. External links resolve.
An independent review checked facts, samples, links and markdown rendering.
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: a9294dec-1bd4-447c-afb8-0390f0de9008
Commits
Reviewing files that changed from the base of the PR and between b4cf164 and d6599c7.
Files selected for processing: 1
README.md
Walkthrough
The README now documents the server-only SDK, including installation, API-key authentication, client usage, configuration, migration from 3.x, LiveObjects, and known limitations.
Changes
Server SDK Documentation
Layer / File(s)
Summary
Server SDK setup and usage README.md
The README documents Python 3.8+, installation options, API-key authentication, realtime and HTTP client usage, configuration, migration from 3.x, LiveObjects, and listed limitations.
ably/ably-pubsub-python#736: The README changes its Python version floor and documents the optional vcdiff extra. The code change does not address the issue’s vcdiff error message or other findings.
Suggested reviewers: owenpearson, ttypic
Merge Risk: Low · previous review b4cf1
The README has bounded documentation risks: copied configuration examples can fail, and the token endpoint must not be deployed without authentication. Correcting these examples and clarifying token support would improve readiness; production SDK behavior is unchanged.
Pre-merge checks: 4
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title clearly and concisely describes the main change: updating the README for version 4.0.
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Finishing Touches
Generate unit tests (beta)
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit reads the README page, New server paths now fill the stage. With keys and clients clearly shown, The setup steps are neatly known. It hops through docs, then rests its ears, And nibbles carrots, free of fears.
CodeRabbit Verify
Run CodeRabbit Verify to test the changes in this pull request.
Recent review info
Run configuration
Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: 8d7d7a40-afef-4cb2-9e12-3b3737085340
Commits
Reviewing files that changed from the base of the PR and between 25b705e and b4cf164.
Files selected for processing: 1
README.md
Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Summary
Rewrites the README for the 4.0
ably-pubsub-serverpackage, in the same structure as the otherAbly Pub/Sub READMEs: one-line requirements, the migration table after the quick start, and no text
that repeats the samples. Only
README.mdchanges.What changed
requires-python.pip install ably-pubsub-server. One sentence names thecryptoandvcdiffextras.[!IMPORTANT]note linking to the docs on token authentication, a token request served from a FastAPI endpoint at/ably-auththat device SDKs use as theirauthUrl, plus two sentences on the event loop. The sync client is one sentence.ABLY_API_KEYenvironment variable.How it was validated
main: package name, extras,requires-python, the client factories, options and the LiveObjects API.py_compile./ably-authendpoint sample runs under FastAPI's test client against themainsources. With a dummy key, it returns a token request withContent-Type: application/json, and the lifespan closes the client on shutdown.main. External links resolve.Follow-ups
Risk Assessment
Summary by CodeRabbit