django-analytical |latest-version|
|build-status| |coverage| |python-support| |license| |gitter| |jazzband|
The django-analytical application integrates analytics services into a
Django_ project.
.. start docs include
Using an analytics service with a Django project means adding Javascript
tracking code to the project templates. Of course, every service has
its own specific installation instructions. Furthermore, you need to
include your unique identifiers, which then end up in the templates.
Not very nice.
This application hides the details of the different analytics services
behind a generic interface, and keeps personal information and
configuration out of the templates. Its goal is to make the basic
set-up very simple, while allowing advanced users to customize tracking.
Each service is set up as recommended by the services themselves, using
an asynchronous version of the Javascript code if possible.
.. end docs include
.. |latest-version| image:: https://img.shields.io/pypi/v/django-analytical.svg
:alt: Latest version on PyPI
:target: https://pypi.org/project/django-analytical/
.. |build-status| image:: https://img.shields.io/travis/jazzband/django-analytical/master.svg
:alt: Build status
:target: https://travis-ci.org/jazzband/django-analytical
.. |coverage| image:: https://img.shields.io/coveralls/github/jazzband/django-analytical/master.svg
:alt: Test coverage
:target: https://coveralls.io/r/jazzband/django-analytical
.. |python-support| image:: https://img.shields.io/pypi/pyversions/django-analytical.svg
:target: https://pypi.org/project/django-analytical/
:alt: Python versions
.. |license| image:: https://img.shields.io/pypi/l/django-analytical.svg
:alt: Software license
:target: https://github.com/jazzband/django-analytical/blob/master/LICENSE.txt
.. |gitter| image:: https://img.shields.io/gitter/room/jazzband/django-analytical.svg
:alt: Gitter chat room
:target: https://gitter.im/jazzband/django-analytical
.. |jazzband| image:: https://jazzband.co/static/img/badge.svg
:alt: Jazzband
:target: https://jazzband.co/
.. _Django: http://www.djangoproject.com/
Currently Supported Services
Chartbeat_ traffic analysisClickmap_ visual click trackingClicky_ traffic analysisCrazy Egg_ visual click trackingFacebook Pixel_ advertising analyticsGaug.es_ real time web analyticsGoogle Analytics_ traffic analysisGoSquared_ traffic monitoringHotjar_ analytics and user feedbackHubSpot_ inbound marketingIntercom_ live chat and supportKISSinsights_ feedback surveysKISSmetrics_ funnel analysisMixpanel_ event trackingOlark_ visitor chatOptimizely_ A/B testingPerformable_ web analytics and landing pagesMatomo (formerly Piwik)_ open source web analyticsRating\@Mail.ru_ web analyticsSnapEngage_ live chatSpring Metrics_ conversion trackingUserVoice_ user feedback and helpdeskWoopra_ web analyticsYandex.Metrica_ web analytics
.. _Chartbeat: http://www.chartbeat.com/
.. _Clickmap: http://getclickmap.com/
.. _Clicky: http://getclicky.com/
.. _Crazy Egg: http://www.crazyegg.com/
.. _Facebook Pixel: https://developers.facebook.com/docs/facebook-pixel/
.. _Gaug.es: http://get.gaug.es/
.. _Google Analytics: http://www.google.com/analytics/
.. _GoSquared: http://www.gosquared.com/
.. _Hotjar: https://www.hotjar.com/
.. _HubSpot: http://www.hubspot.com/
.. _Intercom: http://www.intercom.io/
.. _KISSinsights: http://www.kissinsights.com/
.. _KISSmetrics: http://www.kissmetrics.com/
.. _Mixpanel: http://www.mixpanel.com/
.. _Olark: http://www.olark.com/
.. _Optimizely: http://www.optimizely.com/
.. _Performable: http://www.performable.com/
.. _Matomo (formerly Piwik): https://matomo.org
.. _Rating\@Mail.ru: http://top.mail.ru/
.. _SnapEngage: http://www.snapengage.com/
.. _Spring Metrics: http://www.springmetrics.com/
.. _UserVoice: http://www.uservoice.com/
.. _Woopra: http://www.woopra.com/
.. _Yandex.Metrica: http://metrica.yandex.com
Documentation and Support
The documentation can be found in the docs directory or read
online. The source code and issue tracker are generously hosted by
GitHub. Bugs should be reported there, whereas for lengthy chats
and coding support when implementing new service integrations you're
welcome to use our Gitter chat room_.
.. _read online: https://django-analytical.readthedocs.io/
.. _hosted by GitHub: https://github.com/jazzband/django-analytical
.. _Gitter chat room: https://gitter.im/jazzband/django-analytical
How To Contribute
.. start contribute include
If you want to help out with the development of django-analytical, by
posting detailed bug reports, proposing new features or other analytics
services to support, or suggesting documentation improvements, use the
issue tracker. If you want to get your hands dirty, great! Clone
the repository, make changes and place a pull request. Creating an
issue to discuss your plans is useful.
This is a Jazzband_ project. By contributing you agree to abide by the
Contributor Code of Conduct_ and follow the guidelines_.
.. _issue tracker: https://github.com/jazzband/django-analytical/issues
.. _pull request: https://github.com/jazzband/django-analytical/pulls
.. _Jazzband: https://jazzband.co
.. _Contributor Code of Conduct: https://jazzband.co/about/conduct
.. _guidelines: https://jazzband.co/about/guidelines
.. end contribute include
