Metadata-Version: 1.0
Name: django-funkymetrics
Version: 0.1.9
Summary: Super simple Django application for easily tracking events and submitting them asynchronously to KISSmetrics.
Home-page: https://github.com/funkbit/django-funkymetrics
Author: Funkbit AS
Author-email: post@funkbit.no
License: BSD
Description: # django-funkymetrics
        
        django-funkymetrics is a super simple Django application for easily tracking events and submit them asynchronously to KISSmetrics using celery tasks.
        
        ## Features
        
        * Track app events easily
        * Submits analytics events asynchronously to KISSmetrics
        
        ## Installation
        
        Add the KISSmetrics JS snippet to your project template(s).
        
        Install `django-funkymetrics`:
        
            pip install django-funkymetrics
        
        Alternatively, download the source code and manually add it to your `PYTHONPATH`.
        
        Set your KISSmetrics API key:
        
            KISS_API_KEY = '<your_api_key>'
        
        Track events and profit.
        
        ## Prerequisites
        
        The library assumes that Celery is installed and configured for the Django project. Tasks are automatically created for each `record_event`.
        
        ## Usage
        
        Simply import `record_event` in your code where you want to track events, and call it as needed:
        
            from funkymetrics.events import record_event
            
            # Without properties
            record_event(request, 'downgraded')
            
            # With properties
            record_event(request, 'upgraded plan', {'to_plan': 'Standard'})
        
        The request object is used to identify the user the event is associated with.
        
        When the request isn't available, a user instance can be passed instead. Note that we can't extract the anonymous KISSmetrics identifier from the user object, so it doesn't really make sense to pass anonymous users.
        
        ## Identifying users
        
        Anonymous users are identified by their KISSmetrics anonymous ID (ie. the value of the `km_ai` cookie).
        
        Authenticated users are identified by their username.
        
        ## Future stuff
        
        * Overriding user identifiers
        * Queue events locally and submit in batches
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
