invenio-stats


Nameinvenio-stats JSON
Version 5.0.0 PyPI version JSON
download
home_pagehttps://github.com/inveniosoftware/invenio-stats
SummaryInvenio module for collecting statistics.
upload_time2024-12-10 08:41:53
maintainerNone
docs_urlNone
authorCERN
requires_python>=3.7
licenseMIT
keywords invenio statistics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ..
    This file is part of Invenio.
    Copyright (C) 2017-2018 CERN.

    Invenio is free software; you can redistribute it and/or modify it
    under the terms of the MIT License; see LICENSE file for more details.


===============
 Invenio-Stats
===============

.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-stats.svg
        :target: https://github.com/inveniosoftware/invenio-stats/blob/master/LICENSE

.. image:: https://github.com/inveniosoftware/invenio-stats/workflows/CI/badge.svg
        :target: https://github.com/inveniosoftware/invenio-stats/actions?query=workflow%3ACI

.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-stats.svg
        :target: https://coveralls.io/r/inveniosoftware/invenio-stats

.. image:: https://img.shields.io/pypi/v/invenio-stats.svg
        :target: https://pypi.org/pypi/invenio-stats

Invenio module for collecting statistics.

This module provides the components for **statistical data processing and
querying**.

The most common statistics measure the occurence of events in an invenio
application, e.g. file downloads, record views and others. Invenio-stats
provides the tools to transform, register, compress and query those events.
However, statistics can be fully customized and directly query the database.

The services it uses are:

- RabbitMQ for buffering incoming events.
- Elasticsearch or OpenSearch for aggregating and searching events.

Further documentation is available on: https://invenio-stats.readthedocs.io/

..
    This file is part of Invenio.
    Copyright (C) 2017-2023 CERN.
    Copyright (C) 2024 Graz University of Technology.

    Invenio is free software; you can redistribute it and/or modify it
    under the terms of the MIT License; see LICENSE file for more details.


Changes
=======

Version 5.0.0 (release 2024-12-10)

- tests: remove dependency to invenio-oauth2server
- setup: bump major dependencies

Version 4.2.1 (release 2024-11-30)

- setup: change to reusable workflows
- setup: pin dependencies

Version v4.2.0 (released 2024-08-27)

- processors: allow filtering out robots/machines

Version 4.1.0 (release 2024-08-14)
----------------------------------

- introduce a new config `STATS_REGISTER_INDEX_TEMPLATES` to be able to register
  events and aggregations as index templates (ensure backwards compatibility)


Version 4.0.2 (release 2024-03-04)
----------------------------------

- aggregations: consider updated_timestamp field optional (ensure backwards compatibility)

Version 4.0.1 (release 2023-10-09)
----------------------------------

- aggregations: ensure events are aggregated only once

Version 4.0.0 (release 2023-10-03)
----------------------------------

- introduce new field `updated_timestamp`` in the events and stats templates
  and mappings
- improved calculation of aggregations skipping already aggregated events
- changed `refresh_interval` from 1m to 5s
- changed default events index name from daily to monthly
- moved BookmarkAPI to a new module

Version 3.1.0 (release 2023-04-20)
----------------------------------

- add extension method for building and caching queries

Version 3.0.0 (release 2023-03-01)
-------------------------------------

- Upgrade to ``invenio-search`` 2.x
- Drop support for Elasticsearch 2, 5, and 6
- Add support for OpenSearch 1 and 2
- Drop support for Python 2.7 and 3.6
- Remove function ``invenio_stats.utils:get_doctype``
- Fix ``validate_arguments`` for query classes
- Add ``build_event_emitter`` function for creating an ``EventEmitter`` but not registering it as a signal handler
- Add ``ext.get_event_emitter(name)``` function for caching built ``EventEmitter`` objects per name
- Replace elasticsearch-specific terminology

Version 2.0.0 (release 2023-02-23)
-------------------------------------

- add opensearch2 compatibility

Version 1.0.0a18 (release 2020-09-01)
-------------------------------------

- Fix isort arguments
- Filter pytest deprecation warnings
- Set default values for metrics instead of None, when no index found

Version 1.0.0a17 (release 2020-03-19)
-------------------------------------

- Removes Python 2.7 support.
- Centralizes Flask dependency via ``invenio-base``.

Version 1.0.0a16 (release 2020-02-24)
-------------------------------------

- bump celery dependency
- pin Werkzeug version

Version 1.0.0a15 (release 2019-11-27)
-------------------------------------

- Pin celery dependency

Version 1.0.0a14 (release 2019-11-27)
-------------------------------------

- Fix `get_bucket_size` method

Version 1.0.0a13 (release 2019-11-08)
-------------------------------------

- Bump invenio-queues

Version 1.0.0a12 (release 2019-11-08)
-------------------------------------

- Fixes templates for ElasticSearch 7
- Updates dependency of invenio-search

Version 1.0.0a11 (release 2019-10-02)
-------------------------------------

- Initial public release.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/inveniosoftware/invenio-stats",
    "name": "invenio-stats",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "invenio statistics",
    "author": "CERN",
    "author_email": "info@invenio-software.org",
    "download_url": "https://files.pythonhosted.org/packages/d7/c8/c42ccaad2371611b286910b4e7ff3cc3f0de2e49e3bc2d89e5a1ce567481/invenio_stats-5.0.0.tar.gz",
    "platform": "any",
    "description": "..\n    This file is part of Invenio.\n    Copyright (C) 2017-2018 CERN.\n\n    Invenio is free software; you can redistribute it and/or modify it\n    under the terms of the MIT License; see LICENSE file for more details.\n\n\n===============\n Invenio-Stats\n===============\n\n.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-stats.svg\n        :target: https://github.com/inveniosoftware/invenio-stats/blob/master/LICENSE\n\n.. image:: https://github.com/inveniosoftware/invenio-stats/workflows/CI/badge.svg\n        :target: https://github.com/inveniosoftware/invenio-stats/actions?query=workflow%3ACI\n\n.. image:: https://img.shields.io/coveralls/inveniosoftware/invenio-stats.svg\n        :target: https://coveralls.io/r/inveniosoftware/invenio-stats\n\n.. image:: https://img.shields.io/pypi/v/invenio-stats.svg\n        :target: https://pypi.org/pypi/invenio-stats\n\nInvenio module for collecting statistics.\n\nThis module provides the components for **statistical data processing and\nquerying**.\n\nThe most common statistics measure the occurence of events in an invenio\napplication, e.g. file downloads, record views and others. Invenio-stats\nprovides the tools to transform, register, compress and query those events.\nHowever, statistics can be fully customized and directly query the database.\n\nThe services it uses are:\n\n- RabbitMQ for buffering incoming events.\n- Elasticsearch or OpenSearch for aggregating and searching events.\n\nFurther documentation is available on: https://invenio-stats.readthedocs.io/\n\n..\n    This file is part of Invenio.\n    Copyright (C) 2017-2023 CERN.\n    Copyright (C) 2024 Graz University of Technology.\n\n    Invenio is free software; you can redistribute it and/or modify it\n    under the terms of the MIT License; see LICENSE file for more details.\n\n\nChanges\n=======\n\nVersion 5.0.0 (release 2024-12-10)\n\n- tests: remove dependency to invenio-oauth2server\n- setup: bump major dependencies\n\nVersion 4.2.1 (release 2024-11-30)\n\n- setup: change to reusable workflows\n- setup: pin dependencies\n\nVersion v4.2.0 (released 2024-08-27)\n\n- processors: allow filtering out robots/machines\n\nVersion 4.1.0 (release 2024-08-14)\n----------------------------------\n\n- introduce a new config `STATS_REGISTER_INDEX_TEMPLATES` to be able to register\n  events and aggregations as index templates (ensure backwards compatibility)\n\n\nVersion 4.0.2 (release 2024-03-04)\n----------------------------------\n\n- aggregations: consider updated_timestamp field optional (ensure backwards compatibility)\n\nVersion 4.0.1 (release 2023-10-09)\n----------------------------------\n\n- aggregations: ensure events are aggregated only once\n\nVersion 4.0.0 (release 2023-10-03)\n----------------------------------\n\n- introduce new field `updated_timestamp`` in the events and stats templates\n  and mappings\n- improved calculation of aggregations skipping already aggregated events\n- changed `refresh_interval` from 1m to 5s\n- changed default events index name from daily to monthly\n- moved BookmarkAPI to a new module\n\nVersion 3.1.0 (release 2023-04-20)\n----------------------------------\n\n- add extension method for building and caching queries\n\nVersion 3.0.0 (release 2023-03-01)\n-------------------------------------\n\n- Upgrade to ``invenio-search`` 2.x\n- Drop support for Elasticsearch 2, 5, and 6\n- Add support for OpenSearch 1 and 2\n- Drop support for Python 2.7 and 3.6\n- Remove function ``invenio_stats.utils:get_doctype``\n- Fix ``validate_arguments`` for query classes\n- Add ``build_event_emitter`` function for creating an ``EventEmitter`` but not registering it as a signal handler\n- Add ``ext.get_event_emitter(name)``` function for caching built ``EventEmitter`` objects per name\n- Replace elasticsearch-specific terminology\n\nVersion 2.0.0 (release 2023-02-23)\n-------------------------------------\n\n- add opensearch2 compatibility\n\nVersion 1.0.0a18 (release 2020-09-01)\n-------------------------------------\n\n- Fix isort arguments\n- Filter pytest deprecation warnings\n- Set default values for metrics instead of None, when no index found\n\nVersion 1.0.0a17 (release 2020-03-19)\n-------------------------------------\n\n- Removes Python 2.7 support.\n- Centralizes Flask dependency via ``invenio-base``.\n\nVersion 1.0.0a16 (release 2020-02-24)\n-------------------------------------\n\n- bump celery dependency\n- pin Werkzeug version\n\nVersion 1.0.0a15 (release 2019-11-27)\n-------------------------------------\n\n- Pin celery dependency\n\nVersion 1.0.0a14 (release 2019-11-27)\n-------------------------------------\n\n- Fix `get_bucket_size` method\n\nVersion 1.0.0a13 (release 2019-11-08)\n-------------------------------------\n\n- Bump invenio-queues\n\nVersion 1.0.0a12 (release 2019-11-08)\n-------------------------------------\n\n- Fixes templates for ElasticSearch 7\n- Updates dependency of invenio-search\n\nVersion 1.0.0a11 (release 2019-10-02)\n-------------------------------------\n\n- Initial public release.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Invenio module for collecting statistics.",
    "version": "5.0.0",
    "project_urls": {
        "Homepage": "https://github.com/inveniosoftware/invenio-stats"
    },
    "split_keywords": [
        "invenio",
        "statistics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c2184eb84894d75820b4db3e8209e58bc1fafc284b4e7e2d1a88a65c9da5c6ca",
                "md5": "5515f51b14c7ff3bf7cec0bda6039b12",
                "sha256": "dfcbf01817d0f9a4967d2017fd4cb44f015b79321091920d797fba669e2d9176"
            },
            "downloads": -1,
            "filename": "invenio_stats-5.0.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5515f51b14c7ff3bf7cec0bda6039b12",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 50641,
            "upload_time": "2024-12-10T08:41:51",
            "upload_time_iso_8601": "2024-12-10T08:41:51.197319Z",
            "url": "https://files.pythonhosted.org/packages/c2/18/4eb84894d75820b4db3e8209e58bc1fafc284b4e7e2d1a88a65c9da5c6ca/invenio_stats-5.0.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d7c8c42ccaad2371611b286910b4e7ff3cc3f0de2e49e3bc2d89e5a1ce567481",
                "md5": "b9b9492e58cab35b7bec0d784e6f799f",
                "sha256": "b3da12caa2c56c57b33f05ee5e0c2251fa34f64999dd538e5b599acb4f96571b"
            },
            "downloads": -1,
            "filename": "invenio_stats-5.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b9b9492e58cab35b7bec0d784e6f799f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 60567,
            "upload_time": "2024-12-10T08:41:53",
            "upload_time_iso_8601": "2024-12-10T08:41:53.465060Z",
            "url": "https://files.pythonhosted.org/packages/d7/c8/c42ccaad2371611b286910b4e7ff3cc3f0de2e49e3bc2d89e5a1ce567481/invenio_stats-5.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-10 08:41:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "inveniosoftware",
    "github_project": "invenio-stats",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "invenio-stats"
}
        
Elapsed time: 0.42503s