Metadata-Version: 2.1
Name: analytical
Version: 0.0.1
Summary: Python Server Side Analytics
Home-page: http://github.com/rtfd/analytical
Author: Read the Docs, Inc.
Author-email: dev@readthedocs.org
License: MIT
Keywords: analytics donottrack privacy
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*
Requires-Dist: requests
Requires-Dist: six
Requires-Dist: user-agents
Requires-Dist: celery

.. This file is included automatically by docs/index

Analytical - Server Side Analytics
==================================

Analytical is a Python library for sending pageviews and events to analytics platforms
like Google Analytics except from Python rather than JavaScript so it can be done server side.
This has a number of advantages such as working regardless of whether clients block analytics scripts,
privacy sensitive information can be anonymized or removed before sending,
and it allows sending data only known by the server.


Feature support
---------------

* Convenient utilities for anonymizing sensitive information like IP addresses
* Pluggable provider backends for different analytics platforms (currently just Google)

Supports Python 2.7, Python 3.5+, and PyPy.


Example
-------

.. code-block:: python

    import analytical

    provider = analytical.Provider('googleanalytics', 'UA-XXXXXXX-1')
    provider.pageview({
        'dl': 'https://example.com',
        'dt': 'My Page Title',
        'ua': 'user-agent',             # User agent
        'uip: '12.34.56.78',            # User IP address
    })


Resources
---------

* GitHub: https://github.com/rtfd/analytical
* Documentation: https://analytical.readthedocs.io
* IRC: #readthedocs on freenode


