counter-robots


Namecounter-robots JSON
Version 2025.2 PyPI version JSON
download
home_pagehttps://github.com/inveniosoftware/counter-robots
SummaryLibrary for COUNTER-compliant detection of machines and robots.
upload_time2025-02-13 10:05:50
maintainerNone
docs_urlNone
authorInvenio Software
requires_python>=3.7
licenseMIT
keywords counter user-agent robot detection
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ..
    This file is part of COUNTER-Robots.
    Copyright (C) 2018 CERN.

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

================
 COUNTER-Robots
================

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

.. image:: https://github.com/inveniosoftware/counter-robots/workflows/CI/badge.svg
        :target: https://github.com/inveniosoftware/counter-robots/actions

.. image:: https://img.shields.io/coveralls/inveniosoftware/counter-robots.svg
        :target: https://coveralls.io/r/inveniosoftware/counter-robots

.. image:: https://img.shields.io/pypi/v/counter-robots.svg
        :target: https://pypi.org/pypi/counter-robots


Library for COUNTER-compliant detection of machines and robots.

The purpose behind COUNTER is to enable comparable usage statistics by only
reporting genuine user-driven usage for repositories. The purpose behind Code
of Practice for Research Data is to split genuine COUNTER user-driven usage
into human- and machine-based access.

This Python library implements a tiny API to check if a given user agent
string from a browser is considered a robot/crawler/spider or a machine
according to the `Code of Practice for Research Data
<https://doi.org/10.7287/peerj.preprints.26505v1>`_ [1]  as well as the
`COUNTER Code of Practice
<https://www.projectcounter.org/code-of-practice-five-sections/abstract/>`_.

The library depends on official lists published by both projects. You can see
the lists on:

- `Making Data Count
  <https://github.com/CDLUC3/Make-Data-Count/tree/master/user-agents>`_
- `COUNTER <https://github.com/atmire/COUNTER-Robots/>`_

..
    This file is part of COUNTER-Robots.
    Copyright (C) 2018-2025 CERN.

    COUNTER-Robots 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 2025.2 (released on 2025-02-13)

- User agents lists update.

Version 2018.6 (released on 2018-06-15)

- Initial public release.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/inveniosoftware/counter-robots",
    "name": "counter-robots",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "COUNTER, user-agent, robot detection",
    "author": "Invenio Software",
    "author_email": "info@inveniosoftware.org",
    "download_url": "https://files.pythonhosted.org/packages/70/5e/070796e2b6cce119281b0c6d1781c409547dfc0d8e66711aa9acebac4456/counter_robots-2025.2.tar.gz",
    "platform": "any",
    "description": "..\n    This file is part of COUNTER-Robots.\n    Copyright (C) 2018 CERN.\n\n    COUNTER-Robots 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 COUNTER-Robots\n================\n\n.. image:: https://img.shields.io/github/license/inveniosoftware/counter-robots.svg\n        :target: https://github.com/inveniosoftware/counter-robots/blob/master/LICENSE\n\n.. image:: https://github.com/inveniosoftware/counter-robots/workflows/CI/badge.svg\n        :target: https://github.com/inveniosoftware/counter-robots/actions\n\n.. image:: https://img.shields.io/coveralls/inveniosoftware/counter-robots.svg\n        :target: https://coveralls.io/r/inveniosoftware/counter-robots\n\n.. image:: https://img.shields.io/pypi/v/counter-robots.svg\n        :target: https://pypi.org/pypi/counter-robots\n\n\nLibrary for COUNTER-compliant detection of machines and robots.\n\nThe purpose behind COUNTER is to enable comparable usage statistics by only\nreporting genuine user-driven usage for repositories. The purpose behind Code\nof Practice for Research Data is to split genuine COUNTER user-driven usage\ninto human- and machine-based access.\n\nThis Python library implements a tiny API to check if a given user agent\nstring from a browser is considered a robot/crawler/spider or a machine\naccording to the `Code of Practice for Research Data\n<https://doi.org/10.7287/peerj.preprints.26505v1>`_ [1]  as well as the\n`COUNTER Code of Practice\n<https://www.projectcounter.org/code-of-practice-five-sections/abstract/>`_.\n\nThe library depends on official lists published by both projects. You can see\nthe lists on:\n\n- `Making Data Count\n  <https://github.com/CDLUC3/Make-Data-Count/tree/master/user-agents>`_\n- `COUNTER <https://github.com/atmire/COUNTER-Robots/>`_\n\n..\n    This file is part of COUNTER-Robots.\n    Copyright (C) 2018-2025 CERN.\n\n    COUNTER-Robots 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\nChanges\n=======\n\nVersion 2025.2 (released on 2025-02-13)\n\n- User agents lists update.\n\nVersion 2018.6 (released on 2018-06-15)\n\n- Initial public release.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Library for COUNTER-compliant detection of machines and robots.",
    "version": "2025.2",
    "project_urls": {
        "Homepage": "https://github.com/inveniosoftware/counter-robots"
    },
    "split_keywords": [
        "counter",
        " user-agent",
        " robot detection"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9cf2c49185f039b322a458ee978f595d164fadd748a82c21b8d3a019fed199a0",
                "md5": "b89375fe0dc2172e616498f5ecb50841",
                "sha256": "c34d8a3a1df728775f48196f74242c37268b9abc7d919cf4f2a5b6ac879514b7"
            },
            "downloads": -1,
            "filename": "counter_robots-2025.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b89375fe0dc2172e616498f5ecb50841",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7",
            "size": 7417,
            "upload_time": "2025-02-13T10:05:48",
            "upload_time_iso_8601": "2025-02-13T10:05:48.803679Z",
            "url": "https://files.pythonhosted.org/packages/9c/f2/c49185f039b322a458ee978f595d164fadd748a82c21b8d3a019fed199a0/counter_robots-2025.2-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "705e070796e2b6cce119281b0c6d1781c409547dfc0d8e66711aa9acebac4456",
                "md5": "97c1c4f24519304dfe26e362c815e33d",
                "sha256": "dc477abd4199b64211b25f42307ee0835598aa9fbe732a889717466780d3d3f3"
            },
            "downloads": -1,
            "filename": "counter_robots-2025.2.tar.gz",
            "has_sig": false,
            "md5_digest": "97c1c4f24519304dfe26e362c815e33d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 19342,
            "upload_time": "2025-02-13T10:05:50",
            "upload_time_iso_8601": "2025-02-13T10:05:50.485053Z",
            "url": "https://files.pythonhosted.org/packages/70/5e/070796e2b6cce119281b0c6d1781c409547dfc0d8e66711aa9acebac4456/counter_robots-2025.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-13 10:05:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "inveniosoftware",
    "github_project": "counter-robots",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "counter-robots"
}
        
Elapsed time: 0.42083s