# udata-metrics
This plugin adds views to display metrics on datasets, reuses, organizations and site dashboard pages.
It uses hook logic based on udata-front hooks.
We feed these views with data from:
* an optional metrics API for traffic (views, download, external links)
* mongo for stock values (with an aggregation pipeline)
A job can be scheduled to inject traffic metrics in udata's objects metrics.
## Installation
Install [udata](https://github.com/opendatateam/udata).
Remain in the same virtual environment (for Python).
Install **udata-metrics**:
```shell
pip install udata-metrics
```
Modify your local configuration file of **udata** (typically, `udata.cfg`) as following:
```python
PLUGINS = ['metrics']
METRICS_API = 'http://localhost:8005/api'
```
# Changelog
## 2.0.3 (2024-05-28)
- Migrate to Python 3.11 following `udata` dependencies upgrade [#14](https://github.com/opendatateam/udata-metrics/pull/14)
- Add `resources_downloads` to datasets metrics and refactor `update_metrics_for_models` task [#15](https://github.com/opendatateam/udata-metrics/pull/15)
## 2.0.2 (2024-03-20)
- Update translations [#13](https://github.com/opendatateam/udata-metrics/pull/13)
## 2.0.1 (2023-12-01)
- Improve metrics layout [#11](https://github.com/opendatateam/udata-metrics/pull/11)
- Specify that statistics are for the year
- Move datasets graph on the second row in dashboard stats
- Use current month value (and not variation)
- Prevent upper or lowercasing by removing any text transformation
## 2.0.0 (2023-11-21)
- :warning: New metrics logic [#8](https://github.com/opendatateam/udata-metrics/pull/8)
- Add metrics views (using template hook)
- Use optional metrics API (with job to update metrics on objects)
- Remove Influx logic
- Replace mongo legacy image in CI [#6](https://github.com/opendatateam/udata-metrics/pull/6)
## 1.0.2 (2020-07-01)
- Add time condition in the queries to retrieve only last 24 hours results [#4](https://github.com/opendatateam/udata-metrics/pull/4)
## 1.0.1 (2020-05-13)
- Nothing yet
## 1.0.0 (2020-05-12)
Initial release
Raw data
{
"_id": null,
"home_page": "https://github.com/opendatateam/udata-metrics",
"name": "udata-metrics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "udata metrics",
"author": "Open Data Team",
"author_email": "contact@opendata.team",
"download_url": null,
"platform": null,
"description": "# udata-metrics\n\nThis plugin adds views to display metrics on datasets, reuses, organizations and site dashboard pages.\nIt uses hook logic based on udata-front hooks.\nWe feed these views with data from:\n * an optional metrics API for traffic (views, download, external links)\n * mongo for stock values (with an aggregation pipeline)\nA job can be scheduled to inject traffic metrics in udata's objects metrics.\n\n## Installation\n\nInstall [udata](https://github.com/opendatateam/udata). \n\nRemain in the same virtual environment (for Python).\n\nInstall **udata-metrics**:\n\n```shell\npip install udata-metrics\n```\n\nModify your local configuration file of **udata** (typically, `udata.cfg`) as following:\n\n```python\nPLUGINS = ['metrics']\nMETRICS_API = 'http://localhost:8005/api'\n```\n\n# Changelog\n\n## 2.0.3 (2024-05-28)\n\n- Migrate to Python 3.11 following `udata` dependencies upgrade [#14](https://github.com/opendatateam/udata-metrics/pull/14)\n- Add `resources_downloads` to datasets metrics and refactor `update_metrics_for_models` task [#15](https://github.com/opendatateam/udata-metrics/pull/15)\n\n## 2.0.2 (2024-03-20)\n\n- Update translations [#13](https://github.com/opendatateam/udata-metrics/pull/13)\n\n## 2.0.1 (2023-12-01)\n\n- Improve metrics layout [#11](https://github.com/opendatateam/udata-metrics/pull/11)\n - Specify that statistics are for the year\n - Move datasets graph on the second row in dashboard stats\n - Use current month value (and not variation)\n - Prevent upper or lowercasing by removing any text transformation\n\n\n## 2.0.0 (2023-11-21)\n\n- :warning: New metrics logic [#8](https://github.com/opendatateam/udata-metrics/pull/8)\n - Add metrics views (using template hook)\n - Use optional metrics API (with job to update metrics on objects)\n - Remove Influx logic\n- Replace mongo legacy image in CI [#6](https://github.com/opendatateam/udata-metrics/pull/6)\n\n## 1.0.2 (2020-07-01)\n\n- Add time condition in the queries to retrieve only last 24 hours results [#4](https://github.com/opendatateam/udata-metrics/pull/4)\n\n## 1.0.1 (2020-05-13)\n\n- Nothing yet\n\n## 1.0.0 (2020-05-12)\n\nInitial release\n\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": "Connexion handler to metrics service for udata",
"version": "2.0.3",
"project_urls": {
"Homepage": "https://github.com/opendatateam/udata-metrics"
},
"split_keywords": [
"udata",
"metrics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5fb18575a05db95ac77ece3ab58a1cef35ae87d347cd20df6aa2c30000b5e7f7",
"md5": "d4db4bd5704b598c75129c30d5f0b0e7",
"sha256": "2f8ca890a6b9b0067491b46c7b9083d9f533915d1935fed746369ffaf22ab351"
},
"downloads": -1,
"filename": "udata_metrics-2.0.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4db4bd5704b598c75129c30d5f0b0e7",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 14708,
"upload_time": "2024-05-28T09:43:13",
"upload_time_iso_8601": "2024-05-28T09:43:13.091850Z",
"url": "https://files.pythonhosted.org/packages/5f/b1/8575a05db95ac77ece3ab58a1cef35ae87d347cd20df6aa2c30000b5e7f7/udata_metrics-2.0.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-28 09:43:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opendatateam",
"github_project": "udata-metrics",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "udata-metrics"
}
JSON
