|
| 1 | +python-socketio |
| 2 | +=============== |
| 3 | + |
| 4 | +[](https://github.com/miguelgrinberg/python-socketio/actions) [](https://codecov.io/gh/miguelgrinberg/python-socketio) |
| 5 | + |
| 6 | +Python implementation of the `Socket.IO`_ realtime client and server. |
| 7 | + |
| 8 | +Sponsors |
| 9 | +-------- |
| 10 | + |
| 11 | +The following organizations are funding this project: |
| 12 | + |
| 13 | +<br>[Socket.IO](https://socket.io) | [Add your company here!](https://github.com/sponsors/miguelgrinberg)| |
| 14 | +-|- |
| 15 | + |
| 16 | +Many individual sponsors also support this project through small ongoing contributions. Why not [join them](https://github.com/sponsors/miguelgrinberg)? |
| 17 | + |
| 18 | +Version compatibility |
| 19 | +--------------------- |
| 20 | + |
| 21 | +The Socket.IO protocol has been through a number of revisions, and some of these |
| 22 | +introduced backward incompatible changes, which means that the client and the |
| 23 | +server must use compatible versions for everything to work. |
| 24 | + |
| 25 | +If you are using the Python client and server, the easiest way to ensure compatibility |
| 26 | +is to use the same version of this package for the client and the server. If you are |
| 27 | +using this package with a different client or server, then you must ensure the |
| 28 | +versions are compatible. |
| 29 | + |
| 30 | +The version compatibility chart below maps versions of this package to versions |
| 31 | +of the JavaScript reference implementation and the versions of the Socket.IO and |
| 32 | +Engine.IO protocols. |
| 33 | + |
| 34 | +JavaScript Socket.IO version | Socket.IO protocol revision | Engine.IO protocol revision | python-socketio version |
| 35 | +-|-|-|- |
| 36 | +0.9.x | 1, 2 | 1, 2 | Not supported |
| 37 | +1.x and 2.x | 3, 4 | 3 | 4.x |
| 38 | +3.x and 4.x | 5 | 4 | 5.x |
| 39 | + |
| 40 | +Resources |
| 41 | +--------- |
| 42 | + |
| 43 | +- [Documentation](http://python-socketio.readthedocs.io/en/latest/) |
| 44 | +- [PyPI](https://pypi.python.org/pypi/python-socketio) |
| 45 | +- [Change Log](https://github.com/miguelgrinberg/python-socketio/blob/main/CHANGES.md) |
| 46 | +- Questions? See the [questions](https://stackoverflow.com/questions/tagged/python-socketio) others have asked on Stack Overflow, or [ask](https://stackoverflow.com/questions/ask?tags=python+python-socketio) your own question. |
0 commit comments