Name | Flask-SocketIO JSON |
Version |
5.5.1
JSON |
| download |
home_page | None |
Summary | Socket.IO integration for Flask applications |
upload_time | 2025-01-06 19:49:59 |
maintainer | None |
docs_url | https://pythonhosted.org/Flask-SocketIO/ |
author | None |
requires_python | >=3.6 |
license | None |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
|
coveralls test coverage |
No coveralls.
|
Flask-SocketIO
==============
[![Build status](https://github.com/miguelgrinberg/flask-socketio/workflows/build/badge.svg)](https://github.com/miguelgrinberg/Flask-SocketIO/actions) [![codecov](https://codecov.io/gh/miguelgrinberg/flask-socketio/branch/main/graph/badge.svg)](https://codecov.io/gh/miguelgrinberg/flask-socketio)
Socket.IO integration for Flask applications.
Sponsors
--------
The following organizations are funding this project:
![Socket.IO](https://images.opencollective.com/socketio/050e5eb/logo/64.png)<br>[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.
Raw data
{
"_id": null,
"home_page": null,
"name": "Flask-SocketIO",
"maintainer": null,
"docs_url": "https://pythonhosted.org/Flask-SocketIO/",
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Miguel Grinberg <miguel.grinberg@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d1/1f/54d3de4982df695682af99c65d4b89f8a46fe6739780c5a68690195835a0/flask_socketio-5.5.1.tar.gz",
"platform": null,
"description": "Flask-SocketIO\n==============\n\n[![Build status](https://github.com/miguelgrinberg/flask-socketio/workflows/build/badge.svg)](https://github.com/miguelgrinberg/Flask-SocketIO/actions) [![codecov](https://codecov.io/gh/miguelgrinberg/flask-socketio/branch/main/graph/badge.svg)](https://codecov.io/gh/miguelgrinberg/flask-socketio)\n\nSocket.IO integration for Flask applications.\n\nSponsors\n--------\n\nThe following organizations are funding this project:\n\n![Socket.IO](https://images.opencollective.com/socketio/050e5eb/logo/64.png)<br>[Socket.IO](https://socket.io) | [Add your company here!](https://github.com/sponsors/miguelgrinberg)|\n-|-\n\nMany individual sponsors also support this project through small ongoing contributions. Why not [join them](https://github.com/sponsors/miguelgrinberg)?\n\nInstallation\n------------\n\nYou can install this package as usual with pip:\n\n pip install flask-socketio\n\nExample\n-------\n\n```py\nfrom flask import Flask, render_template\nfrom flask_socketio import SocketIO, emit\n \napp = Flask(__name__)\napp.config['SECRET_KEY'] = 'secret!'\nsocketio = SocketIO(app)\n\n@app.route('/')\ndef index():\n return render_template('index.html')\n\n@socketio.event\ndef my_event(message):\n emit('my response', {'data': 'got it!'})\n\nif __name__ == '__main__':\n socketio.run(app)\n```\n\nResources\n---------\n\n- [Tutorial](http://blog.miguelgrinberg.com/post/easy-websockets-with-flask-and-gevent)\n- [Documentation](http://flask-socketio.readthedocs.io/en/latest/)\n- [PyPI](https://pypi.python.org/pypi/Flask-SocketIO)\n- [Change Log](https://github.com/miguelgrinberg/Flask-SocketIO/blob/main/CHANGES.md)\n- 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.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Socket.IO integration for Flask applications",
"version": "5.5.1",
"project_urls": {
"Bug Tracker": "https://github.com/miguelgrinberg/flask-socketio/issues",
"Homepage": "https://github.com/miguelgrinberg/flask-socketio"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47381b75b3ba3452860211ec87710f9854112911a436ee4d155533e0b83b5cd9",
"md5": "3175c12a870e72319eb4c68f1d47d58e",
"sha256": "35a50166db44d055f68021d6ec32cb96f1f925cd82de4504314be79139ea846f"
},
"downloads": -1,
"filename": "Flask_SocketIO-5.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3175c12a870e72319eb4c68f1d47d58e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 18259,
"upload_time": "2025-01-06T19:49:56",
"upload_time_iso_8601": "2025-01-06T19:49:56.555110Z",
"url": "https://files.pythonhosted.org/packages/47/38/1b75b3ba3452860211ec87710f9854112911a436ee4d155533e0b83b5cd9/Flask_SocketIO-5.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d11f54d3de4982df695682af99c65d4b89f8a46fe6739780c5a68690195835a0",
"md5": "96280d80a415138c1f16505f90966485",
"sha256": "d946c944a1074ccad8e99485a6f5c79bc5789e3ea4df0bb9c864939586c51ec4"
},
"downloads": -1,
"filename": "flask_socketio-5.5.1.tar.gz",
"has_sig": false,
"md5_digest": "96280d80a415138c1f16505f90966485",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 37401,
"upload_time": "2025-01-06T19:49:59",
"upload_time_iso_8601": "2025-01-06T19:49:59.056164Z",
"url": "https://files.pythonhosted.org/packages/d1/1f/54d3de4982df695682af99c65d4b89f8a46fe6739780c5a68690195835a0/flask_socketio-5.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-06 19:49:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "miguelgrinberg",
"github_project": "flask-socketio",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "flask-socketio"
}