Metadata-Version: 2.1
Name: counter-robots
Version: 2018.6
Summary: Library for COUNTER-compliant detection of machines and robots.
Home-page: https://github.com/inveniosoftware/counter-robots
Author: CERN
Author-email: info@inveniosoftware.org
License: MIT
Keywords: COUNTER user-agent robot detection
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Development Status :: 5 - Production/Stable
Provides-Extra: all
Provides-Extra: tests
Provides-Extra: docs
Provides-Extra: all
Requires-Dist: Sphinx (>=1.5.1); extra == 'all'
Requires-Dist: check-manifest (>=0.25); extra == 'all'
Requires-Dist: coverage (>=4.0); extra == 'all'
Requires-Dist: isort (>=4.3.3); extra == 'all'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'all'
Requires-Dist: pytest-cov (>=1.8.0); extra == 'all'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'all'
Requires-Dist: pytest (>=2.8.0); extra == 'all'
Requires-Dist: Sphinx (>=1.5.1); extra == 'all'
Requires-Dist: check-manifest (>=0.25); extra == 'all'
Requires-Dist: coverage (>=4.0); extra == 'all'
Requires-Dist: isort (>=4.3.3); extra == 'all'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'all'
Requires-Dist: pytest-cov (>=1.8.0); extra == 'all'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'all'
Requires-Dist: pytest (>=2.8.0); extra == 'all'
Provides-Extra: docs
Requires-Dist: Sphinx (>=1.5.1); extra == 'docs'
Provides-Extra: tests
Requires-Dist: check-manifest (>=0.25); extra == 'tests'
Requires-Dist: coverage (>=4.0); extra == 'tests'
Requires-Dist: isort (>=4.3.3); extra == 'tests'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'tests'
Requires-Dist: pytest-cov (>=1.8.0); extra == 'tests'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'tests'
Requires-Dist: pytest (>=2.8.0); extra == 'tests'

..
    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://img.shields.io/travis/inveniosoftware/counter-robots.svg
        :target: https://travis-ci.org/inveniosoftware/counter-robots

.. 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 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 2018.6 (released on 2018-06-15)

- Initial public release.


