Metadata-Version: 2.4
Name: stapel-profiles
Version: 0.12.2
Summary: User profiles Django app for the Stapel framework
License: MIT
Project-URL: Homepage, https://github.com/usestapel/stapel-profiles
Project-URL: Repository, https://github.com/usestapel/stapel-profiles
Project-URL: Documentation, https://github.com/usestapel/stapel-profiles#readme
Project-URL: Changelog, https://github.com/usestapel/stapel-profiles/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/usestapel/stapel-profiles/issues
Keywords: django,stapel,profiles,users,social
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: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: stapel-core<1.0,>=0.16
Requires-Dist: celery>=5.3
Provides-Extra: kafka
Requires-Dist: confluent-kafka>=2.3; extra == "kafka"
Provides-Extra: all
Requires-Dist: stapel-profiles[kafka]; extra == "all"
Dynamic: license-file

# stapel-profiles

[![CI](https://img.shields.io/github/actions/workflow/status/usestapel/stapel-profiles/ci.yml?branch=main&logo=github&label=CI)](https://github.com/usestapel/stapel-profiles/actions/workflows/ci.yml?query=branch%3Amain)
[![coverage](https://img.shields.io/codecov/c/github/usestapel/stapel-profiles?branch=main&logo=codecov&label=coverage)](https://app.codecov.io/gh/usestapel/stapel-profiles)
[![pypi](https://img.shields.io/pypi/v/stapel-profiles?logo=pypi&logoColor=white&label=pypi)](https://pypi.org/project/stapel-profiles/)
[![downloads](https://static.pepy.tech/badge/stapel-profiles/month)](https://pepy.tech/project/stapel-profiles)
[![python](https://img.shields.io/pypi/pyversions/stapel-profiles?logo=python&logoColor=white)](https://pypi.org/project/stapel-profiles/)
[![license](https://img.shields.io/github/license/usestapel/stapel-profiles)](https://github.com/usestapel/stapel-profiles/blob/main/LICENSE)
[![llms.txt](https://img.shields.io/badge/llms.txt-blue)](https://github.com/usestapel/stapel-profiles/blob/main/docs/llms.txt)

> User profiles — avatars, social graph (follow/block), privacy settings, language preferences

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) · [Errores (ES)](docs/errors.es.md)

## Installation

```bash
pip install stapel-profiles
```

## Quick start

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

## Bus events

### Emits
| `profile.updated` | [schema](schemas/emits/profile.updated.json) | User profile fields were updated. |

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

## License

MIT — see [LICENSE](LICENSE)
