Metadata-Version: 1.1
Name: addthis
Version: 0.1.1
Summary: A Python wrapper for the AddThis Analytics API
Home-page: https://github.com/creafz/python-addthis
Author: Alex Parinov
Author-email: creafz@gmail.com
License: MIT License
Download-URL: https://github.com/creafz/python-addthis/tarball/0.1.1
Description: ==============
        python-addthis
        ==============
        .. image:: https://pypip.in/version/addthis/badge.svg
            :target: https://pypi.python.org/pypi/addthis/
            :alt: Latest Version
        
        .. image:: https://travis-ci.org/creafz/python-addthis.svg?branch=master
            :target: https://travis-ci.org/creafz/python-addthis
        
        .. image:: https://coveralls.io/repos/creafz/python-addthis/badge.png?branch=master
            :target: https://coveralls.io/r/creafz/python-addthis?branch=master
        
        A Python wrapper for the `AddThis Analytics API <http://support.addthis.com/customer/portal/articles/381264-addthis-analytics-api/>`_.
        
        Requirements
        ------------
        * Python 2.6, 2.7 or 3.2+
        * `python-requests <https://pypi.python.org/pypi/requests/>`_ library
        
        Installation
        ------------
        Install from PyPI::
        
            pip install addthis
        
        Usage
        -----
        
        ::
        
            from addthis import Addthis
        
            # create an AddThis instance using userid and password from your AddThis account and optionally provide a pubid
            addthis = Addthis(userid="YOUR_USER_ID", password="YOUR_PASSWORD", pubid="YOUR_PUB_ID")
        
            # get the number of shares for the last day
            print addthis.shares.day()
        
            # get the number of shares by day for the last week
            print addthis.shares.day(period="week")
        
        
        You can see a full description of all supported metrics and dimensions at http://support.addthis.com/customer/portal/articles/381264-addthis-analytics-api
        
        A few more examples
        ~~~~~~~~~~~~~~~~~~~
        
        **How many times was my content shared on Twitter, by day, over the last week?**
        ::
        
            >>> addthis.shares.day(period="week", service="twitter")
        
        **What were my top shared urls for the pubid="MY_PUB_ID"?**
        ::
        
            >>> addthis.shares.url(pubid="MY_PUB_ID")
        
        **How many users shared my content this month, broken down by their interests?**
        ::
        
            >>> addthis.sharers.interest(period="month")
        
        **Which sharing services sent the most clicks back to my site this week?**
        ::
        
            >>> addthis.clicks.service(period="week")
        
        Exceptions
        ----------
        
        AddthisValidationError
        ~~~~~~~~~~~~~~~~~~~~~~
        Addthis object expects to be called with 2 parameters - "metric" and "dimension"::
        
            addthis.<metric>.<dimension>()
        
        
        For example::
        
             >>> addthis.shares.day() # "shares" is a metric and "day" is a dimension
        
        
        If it gets another number of parameters (e.g. addthis.shares() or addthis.shares.day.week()) it will raise an **AddthisValidationError**.
        
        AddthisError
        ~~~~~~~~~~~~
        **AddthisError** is raised when AddThis service returns a response with a HTTP status code other than 200. The exception object has 4 attributes:
        
        * *status_code*: Code from the HTTP response.
        * *code*, *message*, *attachment*: Error attributes from the AddThis response body. (see the “Error" section in the `AddThis Analytics API documentation <http://support.addthis.com/customer/portal/articles/381264-addthis-analytics-api/>`_ for more information).
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: PyPy
