Metadata-Version: 2.5
Name: university-analytics
Version: 0.1.0
Summary: University Analytics: privacy-conscious event aggregation, active users, view tracking and institution dashboards for the University platform.
Project-URL: Homepage, https://github.com/NzeStan/University
Project-URL: Documentation, https://github.com/NzeStan/University/blob/main/docs/modules/analytics.md
Project-URL: Source, https://github.com/NzeStan/University
Project-URL: Changelog, https://github.com/NzeStan/University/blob/main/CHANGELOG.md
Author-email: Ifeanyi Stanley <nnamaniifeanyi10@gmail.com>
License-Expression: MIT
License-File: LICENSE
Keywords: africa,aggregation,analytics,dashboards,django,drf,metrics,privacy,university
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.2
Classifier: Framework :: Django :: 6.0
Classifier: Framework :: Django :: 6.1
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
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
Requires-Dist: university-core<0.2,>=0.1
Provides-Extra: test
Requires-Dist: drf-spectacular>=0.27; extra == 'test'
Requires-Dist: pytest-cov>=5; extra == 'test'
Requires-Dist: pytest-django>=4.8; extra == 'test'
Requires-Dist: pytest>=8; extra == 'test'
Description-Content-Type: text/markdown

# university-analytics

Privacy-conscious analytics for the [University platform](https://github.com/NzeStan/University):
event aggregation, active users, content views, and platform and institution dashboards. This is an
optional *level two* module that depends only on `university-core`.

- **Aggregates only.** Ids-only platform events become daily counters, platform-wide and per scope
  (institution, community …). There are no raw events, user ids or payloads.
- **Active users** (daily, weekly, monthly) are counted with short-lived keyed hashes, never
  stored.
- **Views** of any content (posts, events, episodes, listings …) are recorded only if the viewer
  may see the item, once per window, without storing who viewed.
- **Small-group suppression** on scope dashboards stops individuals being singled out.
- **Sinks** forward minimised, pseudonymised events (rotating monthly) to warehouses such as
  ClickHouse or BigQuery.

```bash
pip install university-analytics
```

See [the module documentation](../../docs/modules/analytics.md).
