Readme
Heap is a unique new service that automatically captures all user actions on your site including UI interaction.
This library helps developers integrate Heap analytics_ into their Django
projects.
Install using pip::
pip install django-heap
Add heap to installed apps::
INSTALLED_APPS = (
...
'heap',
)
There is no need to run manage.py syncdb since django-heap has no database
tables. Add the heap context processor::
TEMPLATE_CONTEXT_PROCESSORS = (
...
'heap.context_processors.heap',
)
Finally, configure the app ID in settings.py::
HEAP_APP_ID = '12345...'
To enable Heap tracking, you must include the script tag snippet in your template like so::
<head>
....
{% include 'heap/script.html' %}
</head>
Now you are ready to start tracking.
By default, django-heap tracks your site's superusers as well. You can disable
this by setting the HEAP_TRACK_SUPERUSER flag to False. This prevents
the script tag template from rendering when user has is_superuser property
set to True.
django-heap can automatically call heap.identify with data from the
authenticated user. To do that, you need to set the HEAP_AUTO_ID_USER
setting to True (disabled by default). Only authenticated users will be
identify. The User object's get_full_name method will be used to derive the
name parameter for the identify call, and if User object has an
email field, the email parameter will also be passed. There is
currently no handling for the cases where get_full_name returns the user's
email address.
Note This implementation is currently experimental, so please do it
manually in the BODY tag as suggested by Heap documentation if you find it
doesn't work for you.
You can customize django-heap by simply overriding the default template. There is currently no direct support for custom tracking calls, but it is planned for the next release.
Please report bugs to our BitBucket issue tracker_.
.. _Heap Analytics: https://heapanalytics.com/ .. _issue tracker: https://bitbucket.org/monwara/django-heap/issues
FAQs
Simple Heap analytics integration
We found that django-heap demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.