Metadata-Version: 2.4
Name: django-flosse
Version: 0.2.0a1
Summary: Dead-simple Server-Sent Events for Django via a single decorator.
Project-URL: Homepage, https://github.com/youssufshakweh/django-flosse
Project-URL: Repository, https://github.com/youssufshakweh/django-flosse
Project-URL: Changelog, https://github.com/youssufshakweh/django-flosse/blob/main/CHANGELOG.md
Project-URL: Bug Tracker, https://github.com/youssufshakweh/django-flosse/issues
Author: Youssuf Shakweh
License-Expression: MIT
License-File: LICENSE
Keywords: django,http-streaming,real-time,server-sent-events,sse,streaming
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Framework :: Django :: 5.1
Classifier: Framework :: Django :: 5.2
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: django>=4.2
Provides-Extra: dev
Requires-Dist: mkdocs; extra == 'dev'
Requires-Dist: mkdocs-include-markdown-plugin; extra == 'dev'
Requires-Dist: mkdocs-material; extra == 'dev'
Requires-Dist: mkdocstrings[python]; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-asyncio; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: pytest-django; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: termynal; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-include-markdown-plugin; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Requires-Dist: termynal; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-asyncio; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: pytest-django; extra == 'test'
Description-Content-Type: text/markdown

<div align="center">
  <img src="docs/assets/logo.svg" alt="django-flosse" width="120"/>
  <h1>django-flosse</h1>
  <p>Dead-simple Server-Sent Events for Django via a single decorator.</p>

  <a href="https://pypi.org/project/django-flosse/">
    <img src="https://img.shields.io/pypi/v/django-flosse?color=009688&label=PyPI" alt="PyPI">
  </a>
  <a href="https://pypi.org/project/django-flosse/">
    <img src="https://img.shields.io/pypi/pyversions/django-flosse" alt="Python">
  </a>
  <a href="https://pypi.org/project/django-flosse/">
    <img src="https://img.shields.io/pypi/djversions/django-flosse?label=Django" alt="Django">
  </a>
  <a href="https://pepy.tech/projects/django-flosse">
    <img src="https://static.pepy.tech/personalized-badge/django-flosse?period=monthly&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=GREEN&left_text=downloads" alt="PyPI Downloads">
  </a>
  <img src="https://img.shields.io/badge/license-MIT-009688" alt="License">
  <img src="https://img.shields.io/badge/coverage-99%25-brightgreen" alt="Coverage">
    <img src="https://img.shields.io/badge/async-ready-009688" alt="Async Ready">
</div>

---

```python
from django_flosse import sse_stream

@sse_stream
def live_feed(request):
    for item in my_data_source():
        yield ("update", {"value": item})
```

## Installation

```bash
pip install django-flosse
```

No changes to `INSTALLED_APPS` are required.

## Documentation

Full documentation at **[youssufshakweh.github.io/django-flosse](https://youssufshakweh.github.io/django-flosse)**

- [Quick Start](https://youssufshakweh.github.io/django-flosse/quickstart/)
- [Yield Styles](https://youssufshakweh.github.io/django-flosse/user-guide/yield-styles/)
- [Deployment](https://youssufshakweh.github.io/django-flosse/user-guide/deployment/)
- [API Reference](https://youssufshakweh.github.io/django-flosse/api-reference/)

## Contributing

```bash
git clone https://github.com/youssufshakweh/django-flosse
cd django-flosse
pip install -e ".[test]"
pytest
```

## License

This project is licensed under the [MIT License](LICENSE).