# quart-events
[![PyPI version](https://img.shields.io/pypi/v/quart-events)](https://pypi.org/project/quart-events/)
[![Python Versions](https://img.shields.io/pypi/pyversions/quart-events)](https://pypi.org/project/quart-events/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![](https://github.com/smithk86/quart-events/workflows/pytest/badge.svg)](https://github.com/smithk86/quart-events/actions?query=workflow%3Apytest)
## Usage
quart_events.EventBroker loads a blueprint into Quart which allows clients to subscribe to events via a WebSockets. The app can then generate events that can be sent to all subscribed clients in real-time.
Please see [test/app.py](https://github.com/smithk86/quart-events/blob/main/test/testapp/) for an example app. This app is used when running testing via py.test but can also be run standalone.
## Change Log
### [0.4.2] - 2021-12-23
- Change build system from setuptools to poetry
### [0.4.0] - 2021-11-08
- add type hints and type validation with mypy
- requires asyncio-multisubscriber-queue 0.3.0
- pytest plugin to facilitate capturing events while other tests are running; plugin name is *quart_events_catcher*
- added optional callbacks
- websocket auth improvements
- token is now seemlessly managed using the user's session data
- token has an expiration; user is disconnected from the socket upon expiration
- a callback is available to further validate user using other criteria (like Flask-Login)
Raw data
{
"_id": null,
"home_page": "https://github.com/smithk86/quart-events",
"name": "quart-events",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Kyle Smith",
"author_email": "smithk86@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0b/13/a346d51e5cff8b67277dd02de96299e7597daf651c41b95ab88539026109/quart_events-0.4.3.tar.gz",
"platform": null,
"description": "# quart-events\n\n[![PyPI version](https://img.shields.io/pypi/v/quart-events)](https://pypi.org/project/quart-events/)\n[![Python Versions](https://img.shields.io/pypi/pyversions/quart-events)](https://pypi.org/project/quart-events/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![](https://github.com/smithk86/quart-events/workflows/pytest/badge.svg)](https://github.com/smithk86/quart-events/actions?query=workflow%3Apytest)\n\n## Usage\n\nquart_events.EventBroker loads a blueprint into Quart which allows clients to subscribe to events via a WebSockets. The app can then generate events that can be sent to all subscribed clients in real-time.\n\nPlease see [test/app.py](https://github.com/smithk86/quart-events/blob/main/test/testapp/) for an example app. This app is used when running testing via py.test but can also be run standalone.\n\n## Change Log\n\n### [0.4.2] - 2021-12-23\n\n- Change build system from setuptools to poetry\n\n### [0.4.0] - 2021-11-08\n\n- add type hints and type validation with mypy\n- requires asyncio-multisubscriber-queue 0.3.0\n- pytest plugin to facilitate capturing events while other tests are running; plugin name is *quart_events_catcher*\n- added optional callbacks\n- websocket auth improvements\n - token is now seemlessly managed using the user's session data\n - token has an expiration; user is disconnected from the socket upon expiration\n - a callback is available to further validate user using other criteria (like Flask-Login)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "aquart extension to facilitate event message brokering",
"version": "0.4.3",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4318eb4d0ac080cc20f5b9e15838a3dfb3ffbfcd916354fa7b69f91002853ab0",
"md5": "09096f25aa988c422ca70a1aa3026459",
"sha256": "7d7cf66712b46960942259d737db236f2b0f4ca096ca9ae43c4b9d9af7ba9b0d"
},
"downloads": -1,
"filename": "quart_events-0.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09096f25aa988c422ca70a1aa3026459",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 8666,
"upload_time": "2023-01-17T17:26:45",
"upload_time_iso_8601": "2023-01-17T17:26:45.736166Z",
"url": "https://files.pythonhosted.org/packages/43/18/eb4d0ac080cc20f5b9e15838a3dfb3ffbfcd916354fa7b69f91002853ab0/quart_events-0.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0b13a346d51e5cff8b67277dd02de96299e7597daf651c41b95ab88539026109",
"md5": "e7084c55ed9e06753a58c8c9c4cb6076",
"sha256": "fc76db3326161e7dd0d33cf09580be1702461311c78092f5d21b4de9db47d906"
},
"downloads": -1,
"filename": "quart_events-0.4.3.tar.gz",
"has_sig": false,
"md5_digest": "e7084c55ed9e06753a58c8c9c4cb6076",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 7566,
"upload_time": "2023-01-17T17:26:47",
"upload_time_iso_8601": "2023-01-17T17:26:47.227642Z",
"url": "https://files.pythonhosted.org/packages/0b/13/a346d51e5cff8b67277dd02de96299e7597daf651c41b95ab88539026109/quart_events-0.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 17:26:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "smithk86",
"github_project": "quart-events",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "quart-events"
}