miguelgrinberg.python-socketio

python asyncio eventlet gevent long-polling low-latency socket-io socketio socketio-server web-server websocket

Miguel Grinberg ebde305229 Release 5.3.0		4 years ago
.github	add open collective funding option	4 years ago
bin	rename master branch to main #nolog	4 years ago
docs	Document that callbacks cannot be used in external processes (Fixes https://github.com/miguelgrinberg/Flask-SocketIO/issues/1533)	4 years ago
examples	Pass custom authentication data with client connection (Fixes #661)	4 years ago
socketio	Release 5.3.0	4 years ago
tests	Allow functions to be used for URL, headers and auth data in client connection (Fixes #588)	4 years ago
.gitignore	v5 protocol: add JavaScript client and server examples for testing	4 years ago
.readthedocs.yml	use Python 3.6 for docs build	8 years ago
CHANGES.md	Release 5.3.0	4 years ago
LICENSE	Fixed executable bit on several files	10 years ago
MANIFEST.in	Added build files	10 years ago
README.rst	Updated socketio javascript client versions in documentation	4 years ago
setup.py	Remove Python 2 from PyPI classifiers	4 years ago
tox.ini	Remove unused dependencies in tox.ini file #nolog	4 years ago

README.rst

python-socketio
===============

.. image:: https://github.com/miguelgrinberg/python-socketio/workflows/build/badge.svg
    :target: https://github.com/miguelgrinberg/python-socketio/actions

.. image:: https://codecov.io/gh/miguelgrinberg/python-socketio/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/miguelgrinberg/python-socketio

Python implementation of the `Socket.IO`_ realtime client and server.

Version compatibility
---------------------

The Socket.IO protocol has been through a number of revisions, and some of these
introduced backward incompatible changes, which means that the client and the
server must use compatible versions for everything to work.

If you are using the Python client and server, the easiest way to ensure compatibility
is to use the same version of this package for the client and the server. If you are
using this package with a different client or server, then you must ensure the
versions are compatible.

The version compatibility chart below maps versions of this package to versions
of the JavaScript reference implementation and the versions of the Socket.IO and
Engine.IO protocols.

+------------------------------+-----------------------------+-----------------------------+-------------------------+
| JavaScript Socket.IO version | Socket.IO protocol revision | Engine.IO protocol revision | python-socketio version |
+==============================+=============================+=============================+=========================+
| 0.9.x                        | 1, 2                        | 1, 2                        | Not supported           |
+------------------------------+-----------------------------+-----------------------------+-------------------------+
| 1.x and 2.x                  | 3, 4                        | 3                           | 4.x                     |
+------------------------------+-----------------------------+-----------------------------+-------------------------+
| 3.x and 4.x                  | 5                           | 4                           | 5.x                     |
+------------------------------+-----------------------------+-----------------------------+-------------------------+

Resources
---------

-  `Documentation`_
-  `PyPI`_
-  `Change Log`_
-  Questions? See the `questions`_ others have asked on Stack Overflow, or `ask`_ your own question.

.. _Socket.IO: https://github.com/socketio/socket.io
.. _Documentation: http://python-socketio.readthedocs.io/en/latest/
.. _PyPI: https://pypi.python.org/pypi/python-socketio
.. _Change Log: https://github.com/miguelgrinberg/python-socketio/blob/master/CHANGES.md
.. _questions: https://stackoverflow.com/questions/tagged/python-socketio
.. _ask: https://stackoverflow.com/questions/ask?tags=python+python-socketio