https://github.com/miguelgrinberg/Flask-SocketIO
Socket.IO integration for Flask applications.
https://github.com/miguelgrinberg/Flask-SocketIO
flask flask-socketio python socket-io websocket
Last synced: 8 months ago
JSON representation
Socket.IO integration for Flask applications.
- Host: GitHub
- URL: https://github.com/miguelgrinberg/Flask-SocketIO
- Owner: miguelgrinberg
- License: mit
- Created: 2014-02-09T07:22:50.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-04-27T23:41:16.000Z (over 1 year ago)
- Last Synced: 2024-05-02T04:53:16.657Z (over 1 year ago)
- Topics: flask, flask-socketio, python, socket-io, websocket
- Language: Python
- Size: 809 KB
- Stars: 5,273
- Watchers: 106
- Forks: 888
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-flask - Flask-SocketIO - Socket.IO integration for Flask applications (Utils)
- awesome-flask - Flask-SocketIO - Socket.IO integration for Flask applications (Utils)
- awesome-flask - Flask-SocketIO - Socket.IO integration for Flask applications (Utils)
- jimsghstars - miguelgrinberg/Flask-SocketIO - Socket.IO integration for Flask applications. (Python)
- best-of-web-python - GitHub - 0% open · ⏱️ 06.01.2025): (Websocket Utilities)
README
Flask-SocketIO
==============
[](https://github.com/miguelgrinberg/Flask-SocketIO/actions) [](https://codecov.io/gh/miguelgrinberg/flask-socketio)
Socket.IO integration for Flask applications.
Sponsors
--------
The following organizations are funding this project:
[Socket.IO](https://socket.io) | [Add your company here!](https://github.com/sponsors/miguelgrinberg)|
-|-
Many individual sponsors also support this project through small ongoing contributions. Why not [join them](https://github.com/sponsors/miguelgrinberg)?
Installation
------------
You can install this package as usual with pip:
pip install flask-socketio
Example
-------
```py
from flask import Flask, render_template
from flask_socketio import SocketIO, emit
app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret!'
socketio = SocketIO(app)
@app.route('/')
def index():
return render_template('index.html')
@socketio.event
def my_event(message):
emit('my response', {'data': 'got it!'})
if __name__ == '__main__':
socketio.run(app)
```
Resources
---------
- [Tutorial](http://blog.miguelgrinberg.com/post/easy-websockets-with-flask-and-gevent)
- [Documentation](http://flask-socketio.readthedocs.io/en/latest/)
- [PyPI](https://pypi.python.org/pypi/Flask-SocketIO)
- [Change Log](https://github.com/miguelgrinberg/Flask-SocketIO/blob/main/CHANGES.md)
- Questions? See the [questions](https://stackoverflow.com/questions/tagged/flask-socketio) others have asked on Stack Overflow, or [ask](https://stackoverflow.com/questions/ask?tags=python+flask-socketio+python-socketio) your own question.