Flask-SocketIO


NameFlask-SocketIO JSON
Version 5.4.1 PyPI version JSON
download
home_pageNone
SummarySocket.IO integration for Flask applications
upload_time2024-10-01 09:52:52
maintainerNone
docs_urlhttps://pythonhosted.org/Flask-SocketIO/
authorNone
requires_python>=3.6
licenseNone
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/16/53/a8eece1e8729617056bb754a82f9cbba1011bff1e6a6f82db56958c915cc/flask_socketio-5.4.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.4.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": "0bd29fc23b5bd5c7457b69d91304e2c9244596097327c645cd44de6271badc17",
                "md5": "9e45184a0d572ba1e62e7476173ebdf6",
                "sha256": "895da879d162781b9193cbb8fe8f3cf25b263ff242980d5c5e6c16d3c03930d2"
            },
            "downloads": -1,
            "filename": "Flask_SocketIO-5.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9e45184a0d572ba1e62e7476173ebdf6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 18185,
            "upload_time": "2024-10-01T09:52:50",
            "upload_time_iso_8601": "2024-10-01T09:52:50.362452Z",
            "url": "https://files.pythonhosted.org/packages/0b/d2/9fc23b5bd5c7457b69d91304e2c9244596097327c645cd44de6271badc17/Flask_SocketIO-5.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1653a8eece1e8729617056bb754a82f9cbba1011bff1e6a6f82db56958c915cc",
                "md5": "f93faffc6f0a40338ae339da710f7665",
                "sha256": "2e9b8864a5be37ca54f6c76a4d06b1ac5e0df61fde12d03afc81ab4057e1eb86"
            },
            "downloads": -1,
            "filename": "flask_socketio-5.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "f93faffc6f0a40338ae339da710f7665",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 37261,
            "upload_time": "2024-10-01T09:52:52",
            "upload_time_iso_8601": "2024-10-01T09:52:52.295870Z",
            "url": "https://files.pythonhosted.org/packages/16/53/a8eece1e8729617056bb754a82f9cbba1011bff1e6a6f82db56958c915cc/flask_socketio-5.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-01 09:52:52",
    "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"
}
        
Elapsed time: 0.52115s