Skip to main content

Simple Heap analytics integration

Project description

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.

Installation

Install using pip:

pip install django-heap

Basic usage

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.

Tracking superusers

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.

Customizing django-heap

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.

Reporting bugs

Please report bugs to our BitBucket issue tracker.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

django-heap-0.0.1.zip (5.4 kB view details)

Uploaded Source

django-heap-0.0.1.tar.gz (3.4 kB view details)

Uploaded Source

File details

Details for the file django-heap-0.0.1.zip.

File metadata

  • Download URL: django-heap-0.0.1.zip
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-heap-0.0.1.zip
Algorithm Hash digest
SHA256 938bc21d509b3b8dd7a7daff79f19648800717a24bc28ae971dac26b3bbf2f0b
MD5 243a48be89e81f455e0a6065add311a9
BLAKE2b-256 2bda50a5fa94cad10f9dd0d2c38f800ad49c007c08b42be85293f7af6dd64d2f

See more details on using hashes here.

File details

Details for the file django-heap-0.0.1.tar.gz.

File metadata

File hashes

Hashes for django-heap-0.0.1.tar.gz
Algorithm Hash digest
SHA256 53395bccd4127ad5a3d6523e880a4cfd91cbc1f0a729b358a816529d4713c200
MD5 1ab23c31193818e989d999686cae7e78
BLAKE2b-256 dc71c93faaf3a3350f624447ca244671d2713d068f98f1fa99739c51ab7a7add

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page