Metadata-Version: 2.4
Name: stapel-notifications
Version: 0.5.0
Summary: Push and in-app notifications Django app for the Stapel framework
License: MIT
Project-URL: Homepage, https://github.com/usestapel/stapel-notifications
Project-URL: Repository, https://github.com/usestapel/stapel-notifications
Project-URL: Documentation, https://github.com/usestapel/stapel-notifications#readme
Project-URL: Changelog, https://github.com/usestapel/stapel-notifications/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/usestapel/stapel-notifications/issues
Keywords: django,stapel,notifications,push,firebase
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
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 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: stapel-core<1.0,>=0.10
Provides-Extra: firebase
Requires-Dist: firebase-admin>=6.4; extra == "firebase"
Provides-Extra: kafka
Requires-Dist: confluent-kafka>=2.3; extra == "kafka"
Provides-Extra: all
Requires-Dist: stapel-notifications[firebase,kafka]; extra == "all"
Dynamic: license-file

# stapel-notifications

[![CI](https://github.com/usestapel/stapel-notifications/actions/workflows/ci.yml/badge.svg)](https://github.com/usestapel/stapel-notifications/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/usestapel/stapel-notifications/graph/badge.svg)](https://codecov.io/gh/usestapel/stapel-notifications)
[![PyPI](https://img.shields.io/pypi/v/stapel-notifications.svg)](https://pypi.org/project/stapel-notifications/)

> Notifications — push (Firebase), email, SMS channels with delivery logging

Part of the [Stapel framework](https://github.com/usestapel) — composable Django apps for building production-grade platforms.

**Error reference:** [Errors (EN)](docs/errors.en.md) · [Ошибки (RU)](docs/errors.ru.md)

## Installation

```bash
pip install stapel-notifications
```

## Quick start

```python
# settings.py
INSTALLED_APPS = [
    ...
    'stapel_notifications',
]
```

## Bus events

### Consumes
| `user.deleted` | [schema](schemas/consumes/user.deleted.json) |
| `user.deletion_initiated` | [schema](schemas/consumes/user.deletion_initiated.json) |

## License

MIT — see [LICENSE](LICENSE)
