Metadata-Version: 1.1
Name: woopra.py
Version: 0.3.0
Summary: Alternative Woopra integration with Django support
Home-page: https://github.com/bennylope/woopra.py
Author: Ben Lopatin
Author-email: ben@benlopatin.com
License: MIT license
Description: ========================================
        Woopra Python client with Django support
        ========================================
        
        A Pythonic Woopra client with Django support.
        
        Installation
        ============
        
        ::
        
            pip install woopra.py
        
        Usage
        =====
        
        Client configuration
        --------------------
        
        At a base level, you can set up the client using keywords or a configuration
        dictionary::
        
            >>> import woopra_tracker
            >>> config = {'domain': 'www.example.com'}
            >>> woopra = woopra_tracker.client(**config)
        
        User identification
        -------------------
        
        If you have the user information when you create the tracker instance, you can
        add it then::
        
            >>> config = {'domain': 'www.example.com'}
            >>> woopra = woopra_tracker.client(user={'email': "bug@insects.com"}, **config)
        
        To add identifying information::
        
            >>> woopra.identify(name="Stick Bug")
            {"email": "bug@insects.com", "name": "Stick Bug"}
            >>> woopra.identify(order="Phasmatodea")
            {"email": "bug@insects.com", "name": "Stick Bug", "order": "Phasmatodea"}
        
        As you can see the `identify` method updates the user with parameters and then returns
        the fully updated user data dictionary.
        
        Of course that dictionary can be directly modified, too::
        
            >>> woopra.user['name'] = "Stick Bug"
        
        To then identify the user to Woopra::
        
            >>> woopra.push()
        
        Event tracking
        --------------
        
        Track an event::
        
            >>> woopra.track('purchase')
        
        Add information to the event::
        
            >>> woopra.track('purchase', item='Terrarium', price='50.00')
        
        Django integration
        ------------------
        
        The Django client construction is a shortcut to use a an HttpRequest instance
        to create the tracker.
        
            >>> woopra = woopra_tracker.django(request)
        
        You can pass in missing or alternative values using the keyword pattern here too::
        
            >>> woopra = woopra_tracker.django(request, **config)
        
        However you should be careful doing that as config values added here will *override*
        values from the request.
        
        License
        =======
        
        MIT license
        
        
        
        
        =======
        History
        =======
        
        0.1.0 (2018-03-08)
        ------------------
        
        * First release on PyPI.
        
Keywords: woopra
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
