Skip to content

realtime.client does not export RealtimeClient #286

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.

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

Closed
codelaboratory-bot opened this issue Mar 10, 2025 · 1 comment · Fixed by #294
Closed

realtime.client does not export RealtimeClient #286

codelaboratory-bot opened this issue Mar 10, 2025 · 1 comment · Fixed by #294
Labels
documentation Improvements or additions to documentation python Pull requests that update Python code

Comments

@codelaboratory-bot
Copy link

Improve documentation

Link

https://github.com/supabase/realtime-py/blob/main/README.md?plain=1#L32

Describe the problem

The Readme specifies installing v2.0.0 of the realtime library, right underneath it gives some sample imports and usage. Unfortunately if you follow this your code will not compile with the error "No module named 'realtime.client'"

i.e.

pip install realtime==2.0.0
python -c "from realtime.client import RealtimeClient; print('Import succeeded')"

Describe the improvement

Update the readme with a working example

from realtime import AsyncRealtimeClient, RealtimeSubscribeStates

Additional context

@codelaboratory-bot codelaboratory-bot added the documentation Improvements or additions to documentation label Mar 10, 2025
Copy link

linear bot commented Mar 10, 2025

@grdsdev grdsdev added the python Pull requests that update Python code label Mar 10, 2025 — with Linear
@silentworks silentworks linked a pull request Mar 26, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation python Pull requests that update Python code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants